doc: refresh build/usage docs (paths, xref, version, wording, credits)#258
Merged
Conversation
- Drop the scripts/ prefix from command examples: . env.sh puts scripts/ on PATH, so build.sh / deploy.sh / st.sh / stg.sh / updiff.sh are invoked directly. The scripts/ directory references, the dir-tree listing and the docker/scripts/ helpers (not on PATH) are kept. The build-flow diagram (so3.drawio "build" page) and its exported so3_build.png are updated to match. - Link "event channels" to the AVZ "Event channels" section via a new .. _event_channels: label, instead of landing at the page top. - Bump the documented version to 6.2.0. - Describe current behaviour rather than changes: drop "now" / "no longer" / "anymore" where the prose read like a changelog. - Thank all contributors in the Acknowledgements (docs) and Credits (README) sections.
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.
Various documentation updates (Sphinx docs + README):
scripts/prefix —. env.shputsscripts/onPATH, sobuild.sh/deploy.sh/st.sh/stg.sh/updiff.share invoked directly. Kept: thescripts/directory references, the dir-tree listing, and thedocker/scripts/helpers (not onPATH). The build-flow diagram (so3.drawio"build" page) and its exportedso3_build.pngare updated to match... _event_channels:label) instead of landing at the page top.6.2.0(conf.py).now/no longer/anymorewhere the prose read like a changelog (kept literal boot-trace output, the verbatim Linux coding-style text, and tutorial step sequencing).index.rstand the README.Built locally with
sphinx-build(no new warnings); the diagram was re-exported with the drawio CLI.