Skip to content

docs: bilingual examples on the site, docs links in every README - #16

Merged
4matic merged 4 commits into
mainfrom
docs/site-multilingual
Oct 14, 2026
Merged

4matic merged 4 commits into
mainfrom
docs/site-multilingual

Conversation

@4matic

@4matic 4matic commented Oct 14, 2026 •

Copy link
Copy Markdown
Owner
  • Every example in the guides, reference and introduction gets synced JavaScript/Python tabs; the separate Python page is gone (its content moved into the reference pages). /guides/python/ redirects to Getting started. All Python outputs were run against the package.
  • AGENTS.md: new "Documentation site and READMEs" section (what to update for which change, bilingual examples, Docs: links, redirects), plus a docs step in the workflow and the definition of done.
  • Every section of README.md, js/README.md, python/README.md, rust/README.md, spec/fixtures/README.md and spec/generator/README.md opens with a Docs: line to the matching page. All 84 links and anchors checked against the build; the site's 795 internal links too.

Touches js/, python/ and spec/, so release-please will open a 0.3.3 release PR after merge.

@4matic 4matic changed the title docs(site): JavaScript and Python tabs on every example docs: bilingual examples on the site, docs links in every README Oct 14, 2026
…Python page

Every code example in the guides, the reference and the introduction now has synced
JavaScript/Python tabs (one choice applies site-wide and is remembered). The Python guide's
content moved to where it belongs: the name table to Other functions, dataclasses, to_dict and
typing to parse and ParsedTrack, snake_case options to Options. /guides/python/ redirects to
Getting started, since the PyPI metadata links there.
…ctions to the docs

AGENTS.md gets a "Documentation site and READMEs" section: which pages to update for which
change, bilingual JavaScript/Python tabs for every example with real output, Docs: links in every
README, redirects for moved pages, and a docs step in the workflow and definition of done.
Every README section now opens with a Docs: line pointing at the matching site page.
@4matic
4matic force-pushed the docs/site-multilingual branch from 2602d30 to 1bf2987 Compare October 14, 2026 13:46
@4matic
4matic merged commit 200937f into main Oct 14, 2026
15 checks passed
@4matic
4matic deleted the docs/site-multilingual branch October 14, 2026 13:48
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