ci: add docs bundle build and publish workflow for frontend#63
Merged
Andreas-Garcia merged 2 commits intomainfrom Mar 17, 2026
Merged
ci: add docs bundle build and publish workflow for frontend#63Andreas-Garcia merged 2 commits intomainfrom
Andreas-Garcia merged 2 commits intomainfrom
Conversation
… Python Made-with: Cursor
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.
Description
Adds infrastructure to build and publish a JSON docs bundle from this repo for consumption by the Audiometa frontend. The frontend uses the bundle at build time to render the
/docssection (SEO/AEO). A demo web app is available at audiometa.themusictree.org.Key changes:
scripts/build_docs_bundle.py: Buildspublish/docs-bundle.jsonfrom selected Markdown files indocs/(seeDOC_SLUGS), rewrites internal links to/docs/<slug>, and outputs a JSON object keyed by slug withtitleandcontentper doc..github/workflows/publish-docs-bundle.yml: Runs the script and commitspublish/docs-bundle.jsonwhen it changes. Triggers on: push to tagsv*, pushes touchingdocs/**orscripts/build_docs_bundle.py, andworkflow_dispatch.publish/README.md: Documents the bundle, rebuild steps (local and CI), and the demo URL.README.md: Adds a “Try it” line linking to the demo web app at audiometa.themusictree.org.Related Issues
None.
Type of Change
Pre-PR Checklist
Code Quality
pre-commit run --all-filesTests
pytestpytest --cov=audiometa --cov-report=term-missing --cov-fail-under=85Documentation
Git Hygiene
Breaking Changes
Breaking Changes Description
N/A
Testing Instructions
How to Test
python3 scripts/build_docs_bundle.pyand confirmpublish/docs-bundle.jsonis created/updated with entries for the docs inDOC_SLUGS..mdlinks in bundle content are rewritten to/docs/<slug>(e.g.(METADATA_FORMATS.md)→(/docs/metadata-formats)).docs/and verify the job runs and commitspublish/docs-bundle.jsononly when the file changes.Test Results
Additional Context
contents: writeso it can push the updated bundle back to the repo.DOC_SLUGSinscripts/build_docs_bundle.py(e.g. METADATA_FORMATS.md, METADATA_FIELD_GUIDE.md, etc.).Checklist for Reviewers