docs: restructure the README into an overview plus per-library guides - #27
Merged
Merged
Conversation
The README was 633 lines serving five audiences at once, and did not say what the repo contains until line 481. It is now a 179-line overview: badges, imagery, a "what's in this repo" table, a three-way comparison of the integration paths, one quick-start snippet each, and a docs index. Everything step-by-step moved into a document per library or topic: docs/core-sdk.md (the core SDK had no guide of its own), plus device-identity.md, security.md, migration-3x.md, CONTRIBUTING.md, and a README for the previously undocumented native JUCE sample. Prose moved intact; inbound links and the code comments pointing at the old README sections were repointed. Two things were corrected rather than moved. The CMake options table said "three options", listed five, and omitted MOONBASE_USE_CURL, MOONBASE_BUILD_UI_SNAPSHOTS, MOONBASE_BUILD_JUCE_TESTS, MOONBASE_SANITIZER and MOONBASE_JUCE_VERSION. And bump-version.sh hard-failed the release if the README lost its GIT_TAG line, so it now loops over both files carrying a pinned tag, with docs/core-sdk.md added to the .releaserc.json assets so the rewrite is not discarded.
|
The latest updates on your projects. Learn more about Argos notifications ↗︎
|
|
🎉 This PR is included in version 4.3.0 🎉 The release is available on GitHub release 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
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.
The README was 633 lines serving five audiences at once and did not say what the repo contains until line 481; it is now a 179-line overview with badges, screenshots, a "what's in this repo" table, a three-way comparison of the integration paths, one quick-start snippet each, and a docs index.
Everything step-by-step moved into a document per library or topic:
docs/core-sdk.md(the core SDK had no guide of its own), plusdevice-identity.md,security.md,migration-3x.md,CONTRIBUTING.md, and a README for the previously undocumented native JUCE sample. Prose moved intact, with inbound links and the code comments referencing the old README sections repointed.Two things were corrected rather than moved: the CMake options table said "three options", listed five, and omitted
MOONBASE_USE_CURL,MOONBASE_BUILD_UI_SNAPSHOTS,MOONBASE_BUILD_JUCE_TESTS,MOONBASE_SANITIZERandMOONBASE_JUCE_VERSION; andbump-version.shhard-failed the release if the README lost itsGIT_TAGline, so it now loops over both files carrying a pinned tag, withdocs/core-sdk.mdadded to the.releaserc.jsonassets so the rewrite is not discarded.Verified: both sync scripts'
--checkpass, a scripted link checker validates all 92 relative links and every image path (negative-controlled against missing files and missing anchors),bump-version.sh 9.9.9stamps all four version-bearing files and reverts cleanly, and configure + build +ctestpass 111/111.