Create a style guide for the documentation.#22
Merged
daniel-ferradal-marquez merged 1 commit intomainfrom Apr 14, 2026
Merged
Conversation
Addresses bz57819
daniel-ferradal-marquez
approved these changes
Apr 14, 2026
Member
daniel-ferradal-marquez
left a comment
daniel-ferradal-marquez
left a comment
There was a problem hiding this comment.
Looks good. Merging.
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
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.
Addresses https://bz.apache.org/bugzilla/show_bug.cgi?id=57819 (a mere 13 years later).
Creates a new style guide for the documentation, and links it from the relevant places in the docs-project guides. This is based on what we already do, in the majority of cases, so is more descriptive than prescriptive, so everything in here is certainly up for debate, but it's a place to start.