[docs] docs: Add documentation for --dependabot flag#2364
Merged
Conversation
This commit adds comprehensive documentation for the `gh aw compile --dependabot` flag that was previously undocumented in the user-facing CLI reference. Changes: - Added command examples for --dependabot and --dependabot --force - Documented supported package ecosystems (npm, pip, Go) - Explained manifest file generation for each ecosystem - Documented prerequisites (npm in PATH for npm packages) - Added usage constraints and limitations - Included Starlight note component for important constraints The documentation follows the Diátaxis framework (Reference section), GitHub Docs style guidelines, and maintains consistency with existing CLI documentation. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
github-actions
bot
added
the
documentation
pelikhan
approved these changes
Oct 25, 2025
pelikhan
deleted the
docs/add-dependabot-flag-documentation-4034724dd619916c
branch
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Adds comprehensive documentation for the
gh aw compile --dependabotflag that generates dependency manifests for automated security updates. This flag was previously undocumented in the user-facing CLI reference.Changes Made
--dependabot,--dependabot --force)Documentation Quality
✅ Diátaxis Framework: Correctly positioned in Reference section
✅ GitHub Docs Style: Active voice, clear language, technical accuracy
✅ Developer Experience: Copy-paste ready examples, prerequisites documented
✅ Consistency: Matches existing CLI documentation structure and tone
✅ Build Validation: All checks passed, no broken links
Related Files
docs/src/content/docs/tools/cli.md(CLI reference)Test Plan
npm run build)🤖 Generated with Claude Code