Skip to content

Conversation

@alexeagle
Copy link
Contributor

Fixes #5593

@alexeagle alexeagle requested a review from a team as a code owner October 14, 2025 17:54
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request adds documentation explaining how to generate and publish Starlark API documentation (stardocs) for modules in the Bazel Central Registry. The changes include updates to the main README, a new detailed guide in docs/stardoc.md, and a minor schema update to metadata.schema.json. My review focuses on the correctness and clarity of the new documentation, particularly the provided script snippets. I've identified a couple of high-severity issues in the example script within docs/stardoc.md related to inefficiency and inconsistency, and I have provided suggestions to improve them.

meteorcloudy
meteorcloudy previously approved these changes Oct 15, 2025
@bazel-io bazel-io dismissed meteorcloudy’s stale review October 15, 2025 17:42

Require module maintainers' approval for newly pushed changes.

Copy link
Member

@meteorcloudy meteorcloudy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@meteorcloudy meteorcloudy merged commit 861e23a into bazelbuild:main Oct 16, 2025
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

FR: modules register their docs

2 participants