Skip to content

🔴 Update GitHub About Section

Confirm the docs are published and describe the repository on GitHub.

Previously

This assumes the documentation and README updates were committed and pushed.

Step 1. Confirm the Docs Are Published

On the repository page on GitHub, open the Actions tab.

  • The latest workflow run shows a green check.
  • If the run failed, open it and read the error starting from the last lines. Fix the problem, commit, and push again.

NOTE: Repository Settings / Pages must be set to "GitHub Actions" (as described earlier).

Open the published docs site. The address is usually:

https://youraccount.github.io/your-repo/

Confirm the page loads and the visual displays.

Step 2. Open About Settings

On the repository page, find the About section in the upper right. Click the About Settings (gear icon).

Step 3. Update the About Section

  • [ ] Add or update the description.
  • [ ] Check the box to use your GitHub Pages site as the website.
  • [ ] Add or update the keywords (topics).

Save the changes.

Step 4. Confirm

Reload the repository page. The About section shows the description, and the website link opens the published docs.

Verification

  • [ ] The latest GitHub Actions run passed.
  • [ ] The published docs page loads and the visual displays.
  • [ ] The About section includes a description.
  • [ ] The About section includes a clickable link to the docs.

◄ Back to 🔴 Workflow E