Repository navigation
docs: move operational detail out of the README into docs - #251
Merged
Merged
Conversation
The README keeps getting started, the collection overview, conventions and a short index. The operational sections and the non-obvious behaviour entries move verbatim into docs/.
Mearman
marked this pull request as ready for review
November 12, 2026 13:59
Mearman
marked this pull request as draft
November 12, 2026 13:59
|
🎉 This PR is included in version 3.2.1 🎉 The release is available on:
Your semantic-release bot 📦🚀 |
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
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.
Moves the architecture, heartbeat, autoscaler, node recovery, role controller, release, build and test sections and the non-obvious behaviour entries from the README into linked files under docs/, verbatim apart from in-page anchors rewritten to file links. The README keeps getting started, a short collection overview, conventions, one-line trap titles and an index of the docs. Every non-blank line of the previous README is present in the README or docs.