docs: Update readme generation instructions #555
Merged
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
jhrozek
approved these changes
Oct 5, 2025
|
|
||
| 1. Make your changes to `internal/readme/README.src.md` | ||
| 2. Run `make` in the `internal/readme/` directory to regenerate `README.md` | ||
| 2. Run `go generate ./internal/readme` from the repository root to regenerate `README.md` |
There was a problem hiding this comment.
The make reference seems to be a leftover from when the Makefile was removed in 872b437. The go generate command matches what's in github/workflows/readme-check.yml.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
docs: update README generation instructions in CONTRIBUTING.md
This change updates the "Updating the README" section in CONTRIBUTING.md to reflect the correct workflow for regenerating the top-level README.md. The previous instructions referenced a Makefile and
makecommand, but the actual process uses Go'sgo generatedirective as defined ininternal/readme/doc.go.With this update, contributors are now instructed to edit
internal/readme/README.src.mdand rungo generate ./internal/readmefrom the repository root to regenerateREADME.md.This improves contributor experience and ensures documentation is accurate and up-to-date.
Fixes #554