Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions .dev/roadmap.md
Original file line number Diff line number Diff line change
@@ -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 = <release-branch-name>` 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).
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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

Expand All @@ -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.
2 changes: 1 addition & 1 deletion submodules/arranger
Submodule arranger updated 409 files