Conversation
Manual pages are regenerated from Markdown during releases, so changes made only to generated files are lost. Point contributors to the source files, the existing generation script, and a local preview command. Refs trifectatechfoundation#1389
This branch has not been deployed
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
1 participant
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.
Describe the changes done on this pull request
Explain that manual page changes belong in
docs/man/*.md: edits made only to generated.manfiles are overwritten at release time. Document the existing Docker/Pandoc generation script and a local preview command. This adds guidance without changing the release process or relocating generated files.Refs #1389.
Pull Request Checklist
Validation: checked all four Markdown/generated file pairs, the generation call in
util/update-version.sh, and the documented script path;bash -n util/generate-docs.shandgit diff --checkpass. Documentation only; Cargo checks and man-page regeneration were not run. This is a documentation improvement related to #1389, not a claim to resolve its CI/enforcement discussion.