Expand token creation documentation in README #9
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Add token overview table explaining when each token is needed - Add detailed step-by-step instructions for creating Copilot, cross-repo, and Projects tokens - Add instructions for adding tokens using both GitHub UI and CLI - Add CLI helpers section for token management - Add security best practices - Reference comprehensive token documentation from gh-aw Co-authored-by: pelikhan <[email protected]>
Copilot
AI
changed the title
[WIP] Update documentation for token creation process
Expand token creation documentation in README
Dec 20, 2025
pelikhan
reviewed
Dec 20, 2025
README.md
Outdated
| 3. Enter the secret name and paste your token value | ||
| 4. Click **Add secret** | ||
|
|
||
| **Using GitHub Agentic Workflows CLI (Recommended):** |
- Remove CLI-based token addition instructions - Remove "CLI Helpers for Token Management" section - Simplify to UI-only workflow for adding repository secrets - Add clarification to repeat for each token created Co-authored-by: pelikhan <[email protected]>
- Lead with complete COPILOT_GITHUB_TOKEN setup (create + add to repo) - Move other tokens to "Additional Tokens (Advanced)" section - Use collapsible details for advanced token instructions - Emphasize getting started with Copilot quickly - Keep advanced features accessible but not overwhelming Co-authored-by: pelikhan <[email protected]>
Contributor
Author
Restructured the README to document |
pelikhan
reviewed
Dec 20, 2025
Per feedback, removing the Security Best Practices section from the README to simplify the setup documentation. Co-authored-by: pelikhan <[email protected]>
Collaborator
|
@copilot add checkboxes on todo items |
- Convert all step-by-step instructions to checkbox format - Users can now check off items as they complete each step - Applied to all token creation sections (Copilot, Cross-Repo, Projects, Agent) Co-authored-by: pelikhan <[email protected]>
Contributor
Author
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The README previously had minimal token setup instructions. Users needed to navigate to external documentation to understand token requirements and creation steps.
Changes
Getting started with Copilot: Complete end-to-end setup for
COPILOT_GITHUB_TOKENfirst (token creation + adding to repository) to help users get started quicklyInteractive checklists: All step-by-step instructions use checkboxes (
- [ ]) so users can track their progress as they complete each setup stepAdvanced tokens section: Additional tokens (
GH_AW_GITHUB_TOKEN,GH_AW_PROJECT_GITHUB_TOKEN,GH_AW_AGENT_TOKEN) organized in collapsible sections for users with advanced workflow needsDetailed token creation instructions: Step-by-step guides for each token type with specific permissions required:
UI-only workflow: Simplified token management through GitHub Settings UI (no CLI instructions)
The comprehensive token documentation link remains for advanced use cases.
Original prompt
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.