Conversation
There was a problem hiding this comment.
Pull request overview
This PR consolidates authentication documentation for GitHub Projects operations by moving it from a standalone reference page (auth-projects.mdx) into the ProjectOps pattern page (project-ops.mdx). It also updates all cross-references, renames the recommended secret names, and adds images/descriptions to the examples.
Changes:
- Deletes
docs/src/content/docs/reference/auth-projects.mdxand moves its authentication content intodocs/src/content/docs/patterns/project-ops.mdxunder a new "Authentication for Project Operations" section. - Updates all links and secret name references across
safe-outputs.md,auth.mdx, andproject-tracking.mdto point to the new location and use the newGH_AW_READ_PROJECT_TOKEN/GH_AW_WRITE_PROJECT_TOKENnaming convention. - Adds images and richer descriptions to the Project Board Summarizer and Project Board Maintainer examples in
project-ops.mdx.
Reviewed changes
Copilot reviewed 5 out of 9 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
docs/src/content/docs/patterns/project-ops.mdx |
Adds authentication section, restructures examples with images, updates secret names and internal links |
docs/src/content/docs/reference/auth-projects.mdx |
Deleted — content moved to project-ops.mdx |
docs/src/content/docs/reference/safe-outputs.md |
Updates auth links and secret names from GH_AW_PROJECT_GITHUB_TOKEN to GH_AW_WRITE_PROJECT_TOKEN |
docs/src/content/docs/reference/auth.mdx |
Updates link to project auth from deleted page to new location |
docs/src/content/docs/examples/project-tracking.md |
Updates links to project auth from deleted page to new location |
Comments suppressed due to low confidence (5)
docs/src/content/docs/patterns/project-ops.mdx:174
- The alt text "Workflow summary output generated by Project Board Maintainer" is misleading for this image — based on the file name (
projectops-write-board) and surrounding text, this shows the project board after the maintainer has updated it. A more accurate alt text would describe the updated project board state, such as "Project board after Project Board Maintainer applies field updates".
<picture>
<source media="(prefers-color-scheme: dark)" srcSet="/gh-aw/images/projectops-write-board_dark.png" />
<img alt="Workflow summary output generated by Project Board Maintainer" src="/gh-aw/images/projectops-write-board_light.png" />
docs/src/content/docs/reference/auth-projects.mdx:1
- The sidebar navigation in
docs/astro.config.mjs(line 291) still has an entry{ label: 'Authentication (Projects)', link: '/reference/auth-projects/' }that points to the deletedauth-projects.mdxpage. This will result in a broken sidebar link. This entry should either be removed or updated to point to the new location (/patterns/project-ops/#authentication-for-project-operations). Additionally, a redirect should be added to theredirectsobject (around line 90) to handle any existing external links:'/reference/auth-projects/': '/gh-aw/patterns/project-ops/'.
docs/src/content/docs/reference/safe-outputs.md:511 - Same broken anchor:
#project-token-authenticationshould be#authentication-for-project-operations.
Manages GitHub Projects boards. Requires a write-capable PAT or GitHub App token ([project token authentication](/gh-aw/patterns/project-ops/#project-token-authentication)); default `GITHUB_TOKEN` lacks Projects v2 access. Update-only by default; set `create_if_missing: true` to create boards (requires appropriate token permissions).
docs/src/content/docs/reference/safe-outputs.md:609
- Same broken anchor:
#project-token-authenticationshould be#authentication-for-project-operations.
Creates status updates on GitHub Projects boards to communicate progress, findings, and trends. Status updates appear in the project's Updates tab and provide a historical record of execution. Requires a write-capable PAT or GitHub App token ([project token authentication](/gh-aw/patterns/project-ops/#project-token-authentication)); default `GITHUB_TOKEN` lacks Projects v2 access.
docs/src/content/docs/examples/project-tracking.md:286
- Same broken anchor issue:
#project-token-authenticationdoes not exist on the target page. The correct anchor is#authentication-for-project-operations.
- [Project token authentication](/gh-aw/patterns/project-ops/#project-token-authentication) - Token setup guide
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Uh oh!
There was an error while loading. Please reload this page.