Align plugin documentation with the Buildkite Documentation style guide - #3
Open
karensawrey wants to merge 2 commits into
Open
Align plugin documentation with the Buildkite Documentation style guide#3karensawrey wants to merge 2 commits into
karensawrey wants to merge 2 commits into
Conversation
The repository documentation was aligned with the Buildkite documentation style guide while preserving GitHub rendering and the existing technical content. - Reorganized the README into usage, requirements, security and caching, limitations, development, and license sections - Updated the documentation to use sentence-case headings, active voice, shorter paragraphs, and canonical Buildkite terminology - Preserved the existing configuration examples, version information, security guarantees, and runtime limitations - Added relevant links to the Buildkite command-step and cache-volume documentation - Restructured the development guide into actionable testing, smoke-test, cache override, and release instructions - Avoided docs-site-only syntax that would not render correctly on GitHub The resulting documentation is more consistent with the Buildkite Documentation website and easier to migrate in the future.
karensawrey
changed the title
karensawrey
marked this pull request as ready for review
August 4, 2026 14:33
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.
Description
The repository documentation was aligned with the Buildkite documentation style guide while preserving GitHub rendering and the existing technical content.
The resulting documentation is more consistent with the Buildkite Documentation website and easier to migrate in the future.
Compatibility
These edits do not change documented behavior, commands, configuration examples, compatibility claims, versions, commit requirements, or architecture decisions.
Existing code-block contents and link destinations remain unchanged, and no existing generated heading anchors are removed or renamed.