Skip to content

docs(gazelle): Migrate Gazelle docs to ReadTheDocs, part 2/5: installation and usage #3132

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 2 commits into from
Aug 4, 2025
Merged

docs(gazelle): Migrate Gazelle docs to ReadTheDocs, part 2/5: installation and usage #3132

merged 2 commits into from
Aug 4, 2025

Conversation

dougthor42
Copy link
Collaborator

@dougthor42 dougthor42 commented Aug 2, 2025 •
edited
Loading

Part of #3082

2nd of probably 5 PRs.

  • Migrate installation and usage info from gazelle/README.md to gazelle/docs/installation_and_usage.md
  • Slight rewording and reformatting of the Example section.
  • Reorganized and modernized the MODULE.bazel and BUILD.bazel examples:
  • Mechanical updates:
    • Wrap at ~80 chars
    • Use MyST directives and roles.

@dougthor42 dougthor42 added type: documentation gazelle Gazelle plugin related issues labels Aug 2, 2025
@dougthor42 dougthor42 marked this pull request as ready for review August 2, 2025 05:29
@dougthor42 dougthor42 requested a review from aignas as a code owner August 2, 2025 05:29
aignas
aignas approved these changes Aug 2, 2025
View reviewed changes
@dougthor42 dougthor42 added this pull request to the merge queue Aug 4, 2025
Merged via the queue into bazel-contrib:main with commit 54397d7 Aug 4, 2025
3 checks passed
@dougthor42 dougthor42 mentioned this pull request Aug 5, 2025
Draft
@dougthor42 dougthor42 deleted the u/dthor/gazelle-refactor-docs-pt2-install branch August 6, 2025 16:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@aignas aignas aignas approved these changes

Assignees
No one assigned
Labels
gazelle Gazelle plugin related issues type: documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@dougthor42 @aignas