Skip to content

Overture docs V2 update#48

Open
MitchellShiell wants to merge 3 commits into
mainfrom
overtureDocsUpdate
Open

Overture docs V2 update#48
MitchellShiell wants to merge 3 commits into
mainfrom
overtureDocsUpdate

Conversation

@MitchellShiell

Copy link
Copy Markdown
Collaborator

Reorg of docs site across Deploy/Develop/Use

Summary

  • Restructures the docs site from the ad-hoc Guides/Docs/Workshop layout into three audience-oriented journeys: Deploy, Develop (renamed from Build), and Use, plus a Community section.
  • Consolidates all content under website/docs/{deploy,develop,use,community}-docs/ instead of scattered top-level folders.
  • Vendors component reference docs (Lectern, Lyric, Song, Score, Maestro, Arranger, Stage) consistently via submodule symlinks under Develop.
  • Moves admin guides, CLI workflows, the workshop, and a new Conversational Data Discovery guide under Use; deployment/quickstart content under Deploy.
  • Redirects every old URL (/guides/*, /docs/*, /build/*) to its new home via @docusaurus/plugin-client-redirects.
  • Builds clean under onBrokenLinks: "throw".
  • Diffs against main show mostly renames, not content edits, since nearly every doc file moved. Actual authored changes are small: the Develop rename, a few new/reworked pages, and updated sidebars/symlinker config.

Next Steps

Develop

  • Bringing Develop docs up to date, including updated dev setups that do not rely on prelude or the outdated hard to maintain quickstart
  • Other dev doc updates
    • Song migration script
    • Lyric
    • Lectern Viewer
    • Maestro V5
    • Updated Arranger docs (all mostly included just confirming/reviewing)
      • Chart
      • MCP
      • Introspection
      • Multi-catalog

Deploy

  • Will need to update the deploy docs, particularly making sure envs documented are up to date
  • Will need to expand the deploy docs to include general helm and k8s knowledge (further discussion needed)

Use

  • Aligning use section as guided tutorials covering our three primary end users (admins, consumers, submitters), refining/reviewing conversational interface docs as per required docs

  • Removed prelude and quickstart dedicated docs, prelude will be used for use demos / tutorials but never explicitly documented on its own as each branch represents a specific use case/workshop/workflow demo/material. it's a flexible resource for education purposes that require a local deploy

Description of Changes

Submodule Remote (overture-stack/…) Checked out Uncommitted Local branches
lectern lectern overtureDocsUpdate eb1f620 .DS_Store only main, overtureDocsUpdate
lyric lyric overtureDocsUpdate 3fa8b07 1 file(s) main, overtureDocsUpdate
song song overtureDocsUpdate 788d333a clean develop, ls, score-client, overtureDocsUpdate
score score (detached) 26ecc754 clean develop, master, score-client, score-client2
maestro maestro overtureDocsUpdate bc10c2d clean master, overtureDocsUpdate
arranger arranger overtureMCPdocsUpdate bc15e4c8 clean fix/migration-v3.1-absolute-links, main, overtureMCPdocsUpdate, sqonDoc
stage stage (detached) fa63b86 clean main
.github .github (detached) e750770 clean master

Readiness Checklist

  • Self Review
    • I have performed a self review of code
    • I have run the application locally and manually tested the feature
    • I have checked all updates to correct typos and misspellings
  • Formatting
    • Code follows the project style guide
    • Autmated code formatters (ie. Prettier) have been run
  • Local Testing
    • Successfully built all packages locally
    • Successfully ran all test suites, all unit and integration tests pass
  • Updated Tests
    • Unit and integration tests have been added that describe the bug that was fixed or the features that were added
  • Documentation
    • All new environment variables added to .env.schema file and documented in the README
    • All changes to server HTTP endpoints have open-api documentation
    • All new functions exported from their module have TSDoc comment documentation

@netlify

netlify Bot commented Jul 24, 2026

Copy link
Copy Markdown

Deploy Preview for overturedocs ready!

Name Link
🔨 Latest commit b812ff2
🔍 Latest deploy log https://app.netlify.com/projects/overturedocs/deploys/6a63c8dced558a000878aaab
😎 Deploy Preview https://deploy-preview-48--overturedocs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant