Overture docs V2 update - #48
Open
MitchellShiell wants to merge 19 commits into
Open
Conversation
✅ Deploy Preview for overturedocs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
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.
Overture docs site v2: restructure into Develop / Deploy / Use / Community
Rebuilds the documentation site around four audience-facing sections, replaces the old
docs/guides/workshopsplit, adds the deployment and AI-assisted data discovery guides, and ships three interactive in-page tools. Component reference docs are pulled in from thesubmodules/doc branches, so this PR is blocked onthe submodule PRs in the table below.
overtureDocsUpdate->main· 16 commits · 185 files (+13,787 / -10,069) plus 7 submodule pin bumps.Every component's reference docs live in its own repo and are vendored here as a submodule. This PR's pins currently point at branch tips that are not yet on their default branches. Each row must be merged first, then the pin re-pointed at the resulting default-branch commit before this PR can go in.
submodules/lecternoverture-stack/lecternovertureDocsUpdatemainca2aa45submodules/lyricoverture-stack/lyricovertureDocsUpdatemain181bbb1submodules/songoverture-stack/songovertureDocsUpdatedevelop28a01d6asubmodules/scoreoverture-stack/scoreovertureDocsUpdatedevelop38386151submodules/maestrooverture-stack/maestroovertureDocsUpdatemaster79da1a4submodules/arrangeroverture-stack/arrangerovertureMCPdocsUpdatemain008d98b9submodules/stageoverture-stack/stageovertureDocsUpdatemain580d785All seven branches are pushed and have no unpushed or uncommitted work.
What changed in this repo
Information architecture
The site moves from
docs/guides/workshop/communityto four audience-oriented Docusaurus plugin instances, each with its own sidebar:/developwebsite/docs/develop-docsdevelopSidebars.ts/deploywebsite/docs/deploy-docsdeploySidebars.ts/usewebsite/docs/use-docsuseSidebars.ts/communitywebsite/docs/community-docscommunitySidebars.tssidebars.ts,guidesSidebars.ts,workshopSidebars.tsandcasestudiesSidebars.tsare removed. Navbar becomes Develop / Deploy / Use.
New content
/deploy/deployment): per-component walkthroughs: Keycloak, Song, Score, Lectern, Lyric, search engine, Maestro, Arranger, Stage, plus file transfer, search portal, tabular data submission, and the Arranger MCP server./use/ai-assisted-data-discovery): testing environment, connecting a host, configuration templates, use cases, and deploying your own MCP server./use/administration): building dictionaries, building Song schemas, customizing the data portal, index mappings./develop/api-reference): per-component Swagger pages for Song, Score, Maestro, Lyric, Lectern and Arranger.lecternAPI.jsonadded; the Song, Score, Maestro and Lyric specs are regenerated against current code./use/workshopwith a new generalized intro page.Interactive components
Three browser-only tools, each with a docs page under
/use/config-generators-and-playgrounds:Build and dependencies
3.9.2to3.10.2; package renamedbridge-poctooverture-docs.@overture-stack/lectern-dictionary,@overture-stack/lectern-ui, the CodeMirror editor stack, and@docusaurus/plugin-client-redirects.website/docsPlugin.tsgains webpack config to make the Lectern viewer bundle for the browser: aliasesd3-dagto its ESM build (its CJS build pulls in Node built-ins), stubs Node core modules, rewritesnode:-scheme imports, and silences the resultingd3-dagcritical-dependency warning.react/react-dompinned viaoverridesfor@overture-stack/lectern-ui.Merge order
Verification
npm ci && npm run buildinwebsite/is clean