docs(gazelle): Start migrating Gazelle docs to ReadTheDocs, part 1 of ~5 #3129
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
Part of bazel-contrib#3082 + Set up the Bazel config so that the rules_python root docs can reference and use the gazelle/docs directory. + Replace the original docs/gazelle.md with gazelle/docs/index.md + Migrate general info from gazelle/README.md to gazelle/docs/index.md + Also a drive-by update to building and running docs _without_ `ibazel`.
aignas
approved these changes
Aug 1, 2025
Collaborator
aignas
left a comment
aignas
left a comment
There was a problem hiding this comment.
LGTM, only nits, I'll approve and you can merge when you are done.
gazelle/docs/index.md
Outdated
| # Gazelle Plugin | ||
|
|
||
| [Gazelle][gazelle] is a build file generator for Bazel projects. It can | ||
| create new {code}`BUILD` or {code}`BUILD.bazel` files for a project that |
Collaborator
There was a problem hiding this comment.
nit:
Suggested change
| create new {code}`BUILD` or {code}`BUILD.bazel` files for a project that | |
| create new `BUILD` or `BUILD.bazel` files for a project that |
I would expect this to be still markdown enough so that the above works.
Collaborator
Author
There was a problem hiding this comment.
Done for all instances.
Are there any specific instances where {code} should be kept?
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.
Part of #3082
First of probably 5 PRs.
docs/gazelle.mdwithgazelle/docs/index.mdgazelle/README.mdtogazelle/docs/index.mdibazel.