diff --git a/.dev/roadmap.md b/.dev/roadmap.md new file mode 100644 index 00000000..7c6476ec --- /dev/null +++ b/.dev/roadmap.md @@ -0,0 +1,17 @@ +# overture/docs — Roadmap + +Planned work and known improvements for the Overture documentation site. + +--- + +## Submodule branch tracking + +### Track release branches, not default/main + +**What:** Configure each submodule in `.gitmodules` to track the project's release branch rather than its default branch (currently no `branch` is set, so `git submodule update --remote` follows the remote default, which is `main`). + +**Why:** `main` on each project repo carries in-progress and unreleased changes. The docs site should reflect what has been released, not what is being developed. Pinning to a release branch (e.g. `release` or `release-2.x`) means submodule updates stay in sync with published versions rather than pulling ahead of them. + +**How:** Add a `branch = ` line to each submodule entry in `.gitmodules`, then update the docs publish workflow to run `git submodule update --remote` against those branches. + +**Scope:** Requires confirming the release branch naming convention per project (Arranger uses `release`; verify for SONG, Score, Stage, Maestro, Lectern, Lyric). diff --git a/README.md b/README.md index 34d1bedc..ffbc6d69 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ Overture Docs is a centralized documentation site built with [Docusaurus](https://docusaurus.io/) that aggregates and renders Markdown content from `/docs` directories across our GitHub repositories. It transforms distributed documentation into a cohesive and easy to navigate knowledge base. -![Overture Docs](./preview.png "Docs for developers and informaticians") +![Overture Docs](./preview.png 'Docs for developers and informaticians') > [!NOTE] > This repository is documented in detail on the Overture Docs site linked here (to be linked once live) @@ -75,10 +75,10 @@ npm start - **/submodules/**: Contains all Overture core repositories as Git submodules - **/website/**: Houses the Docusaurus-powered documentation website - - **/community/**: Community-focused content and resources - - **/docs/**: Central location for all documentation, automatically linked from repository submodules - - **/guides/**: Comprehensive platform guides and tutorials - - **/src/**: Website implementation files including custom components, styling, and page content + - **/community/**: Community-focused content and resources + - **/docs/**: Central location for all documentation, automatically linked from repository submodules + - **/guides/**: Comprehensive platform guides and tutorials + - **/src/**: Website implementation files including custom components, styling, and page content ## Benefits of this Setup @@ -90,7 +90,7 @@ npm start - **Robust Error Handling**: Docusaurus has excellent error catching, particularly for broken and missing links, reducing the need for manual testing. -![Pro Tip](./website/docs/02-platform-tools/images/proTip.png "Use Overture Docs repo to search across all Overture repos") +![Pro Tip](./website/docs/02-platform-tools/images/proTip.png 'Use Overture Docs repo to search across all Overture repos') -> [!TIP] +> [!TIP] > The Overture Docs repo contains everything, therefore finding & tracking links and content across all our repos has never been easier. diff --git a/submodules/arranger b/submodules/arranger index 90b3a0b4..8852b8aa 160000 --- a/submodules/arranger +++ b/submodules/arranger @@ -1 +1 @@ -Subproject commit 90b3a0b4d025def37163692baed9e02017b79fae +Subproject commit 8852b8aa657a5d80e63ba1cb950cbf1d382fd3c4