docs: improve documentation and CLI messages for new users - #691
Merged
Conversation
Contributor
Semver Impact of This PR🟢 Patch (bug fixes) 📋 Changelog PreviewThis is how your changes will appear in the changelog. New Features ✨
Bug Fixes 🐛Changelog
Other
Documentation 📚
Build / dependencies / internal 🔧
🤖 This preview updates automatically when you update the PR. |
Contributor
|
- Add craft changelog command documentation to getting-started.md - Add dry-run mode explanation section with blocked vs allowed operations - Document skip-changelog features (#skip-changelog, labels, config) - Add Craft extensions (commit_patterns, semver) to Auto Mode docs - Include link to GitHub's release.yml documentation - Show default conventional commits configuration - Improve GITHUB_TOKEN error message with helpful tip - Update --dry-run help text to be more specific
BYK
force-pushed
the
byk/docs/improve-docs-and-onboarding
branch
from
December 31, 2025 14:14
dfe9cdd to
eab2be0
Compare
BYK
marked this pull request as ready for review
December 31, 2025 14:14
MathurAditya724
approved these changes
Dec 31, 2025
7 tasks
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
2 participants
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
Improves Craft's documentation and CLI output based on new user feedback. The main pain points addressed:
changelogcommand - Users didn't know aboutcraft changelog --since SHAcommit_patternsnot clearly documented as Craft extension - Users didn't know this extends GitHub's release.yml formatChanges
Documentation
craft changelogcommand section to getting-started.mdCLI
GITHUB_TOKENerror message with helpful tip aboutgh auth token--dry-runhelp text to be more specific about what's blocked