Skip to content

docs: reorganize examples by topic and split live dashboards#235

Merged
fahimfaisaal merged 3 commits into
mainfrom
docs/topic-based-examples
Jul 17, 2026
Merged

docs: reorganize examples by topic and split live dashboards#235
fahimfaisaal merged 3 commits into
mainfrom
docs/topic-based-examples

Conversation

@fahimfaisaal

Copy link
Copy Markdown
Member

Summary

  • Split the single parser-oriented Examples page into a topic-based docs section (tabular data, math & 3D, comparisons, GitHub Legends, benchmarks, showcase).
  • Split live CSV dashboards into /examples/tabular-data/, /examples/math-and-3d/, and /examples/comparisons/; move clusters under math-and-3d.
  • Rename JSON contribution skylines to GitHub Legends (/examples/github-legends/) with a Friday cron refresh.
  • Update release.yml, scripts/act-examples.sh, chart deep links, and examples READMEs.

Test plan

  • Docs build (pnpm build in docs/) succeeds and new /examples/* routes render
  • task act:examples -- --only tabular-data,math-and-3d,comparisons --no-open produces topic galleries under dist/examples/
  • Release job graph lists the new prepare workflows (no prepare-csv / prepare-json)
  • After deploy: open each new live path and a few ?id= deep links
  • Confirm GitHub Legends schedule is present on prepare-github-legends.yml

Replace parser-based CSV/JSON example pages with topic hubs (tabular-data,
math-and-3d, comparisons, github-legends, benchmarks, showcase). Split CI
prepare workflows accordingly, rename JSON skylines to GitHub Legends with
a Friday refresh, and update the local act script.
Call api-contract alongside CLI and UI after approval, and require it before
GoReleaser. Enable workflow_call on the contract workflow.
Keep the Examples sidebar group before internals and troubleshooting.
@fahimfaisaal
fahimfaisaal merged commit 1064145 into main Jul 17, 2026
2 checks passed
@fahimfaisaal
fahimfaisaal deleted the docs/topic-based-examples branch July 17, 2026 14:32
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