Skip to content

docs: document API reference docs workflow in DEVELOPER.md - #245

Merged
twishabansal merged 15 commits into
mainfrom
api-docs-developer-docs
Jun 4, 2026
Merged

docs: document API reference docs workflow in DEVELOPER.md#245
twishabansal merged 15 commits into
mainfrom
api-docs-developer-docs

Conversation

@twishabansal

@twishabansal twishabansal commented Jun 2, 2026

Copy link
Copy Markdown
Contributor

No description provided.

twishabansal and others added 14 commits June 1, 2026 14:08
Adds tags:['**'] so the API Reference Deployment workflow fires on tag
pushes, not just main. Inert until a tag is pushed; per-package routing
and root-redirect handling follow in subsequent PRs.
Routes each tag to a single package built at /<pkg>/<version>/, builds
dev from main, and rebuilds the root README only on tag pushes so the
root URL stops flapping. Drops the destructive content wipe and macOS
sed dance.
Add a hand-edited version selector to the API reference docs, mirroring
the genai-toolbox pattern adapted to our per-package layout.

- hugo.toml: per-package [params.versions] lists, version_menu label, and
  custom "releases"/"latest" output formats wired into outputs.home
- home.releases.releases: per-package dropdown fragment served at
  /<pkg>/releases.releases
- home.latest.html: per-package latest redirect, hoisted to /<pkg>/latest/
- navbar-version-selector.html: override that runtime-includes the fragment
  via w3.includeHTML, so frozen old version pages show newly-added versions
  without a rebuild
- head-end.html + static/js/w3.js: load the W3.JS include helper
- generate-api-docs.sh: pass HUGO_PARAMS_PACKAGE and hoist the home-scoped
  outputs to the package root where the navbar fetches them
@twishabansal
twishabansal requested a review from a team as a code owner June 2, 2026 14:19
Base automatically changed from api-docs-backfill to main June 4, 2026 11:32
@twishabansal
twishabansal merged commit b881aa9 into main Jun 4, 2026
15 checks passed
@twishabansal
twishabansal deleted the api-docs-developer-docs branch June 4, 2026 11:34
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.

2 participants