docs: split reference material onto different pages#2250
Merged
jayconrod merged 6 commits intobazel-contrib:masterfrom Dec 6, 2025
Merged
docs: split reference material onto different pages#2250jayconrod merged 6 commits intobazel-contrib:masterfrom
jayconrod merged 6 commits intobazel-contrib:masterfrom
Conversation
Moved several sections out of the main README onto separate pages: - gazelle-reference.md: a language-agnostic reference for commands, directives, and commandline-line flags. - language/go/reference.md: a reference for Go-specific directives, flags, and fix command transformations. The `update-repos` command is now documented here since it has no useful functionality for other languages. - language/proto/reference.md: a reference for Proto-specific directives and flags. I'm hoping this makes the main README more digestible, though there's still a lot of improvement needed there. For bazel-contrib#2196
fmeum
reviewed
Dec 5, 2025
pcj
pushed a commit
to stackb/bazel-gazelle
that referenced
this pull request
Dec 23, 2025
**What type of PR is this?** > Documentation **What package or component does this PR mostly affect?** > all **What does this PR do? Why is it needed?** Moved several sections out of the main README onto separate pages: - gazelle-reference.md: a language-agnostic reference for commands, directives, and commandline-line flags. - language/go/reference.md: a reference for Go-specific directives, flags, and fix command transformations. The `update-repos` command is now documented here since it has no useful functionality for other languages. - language/proto/reference.md: a reference for Proto-specific directives and flags. I'm hoping this makes the main README more digestible, though there's still a lot of improvement needed there. **Which issues(s) does this PR fix?** For bazel-contrib#2196 **Other notes for review**
Closed
4 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.
What type of PR is this?
What package or component does this PR mostly affect?
What does this PR do? Why is it needed?
Moved several sections out of the main README onto separate pages:
directives, and commandline-line flags.
flags, and fix command transformations. The
update-reposcommandis now documented here since it has no useful functionality for
other languages.
directives and flags.
I'm hoping this makes the main README more digestible, though there's
still a lot of improvement needed there.
Which issues(s) does this PR fix?
For #2196
Other notes for review