Skip to content

docs: Align Starlight site with generated hierarchy graphs#119

Draft
DanielKellerM wants to merge 1 commit into
develfrom
docs/align-site-graphs
Draft

docs: Align Starlight site with generated hierarchy graphs#119
DanielKellerM wants to merge 1 commit into
develfrom
docs/align-site-graphs

Conversation

@DanielKellerM

Copy link
Copy Markdown
Collaborator

Draft — work in progress. A single workspace to bring the new Starlight docs site (#103) and the regenerated module-hierarchy graphs (#117) into alignment, and to refresh the docs to the current state of the repo.

Starter in this PR

  • New architecture/hierarchy.md page wired to the ast2dot-generated graphs (/fig/graph/*.png).
  • make idma_doc_site target that copies the generated doc/fig/graph/*.png into the site's public/fig/graph/.
  • .gitignore so the generated graphs aren't committed.

TODO (to be filled in)

  • Regenerate the hierarchy graphs from the current RTL (make idma_doc_all) and verify they render in the site.
  • Bring the architecture/guide pages up to date with the latest repo (post pickle/uv/rename changes).
  • Decide whether/how to build + deploy the Starlight site in CI (currently Pages serves the Sphinx docs).
  • Reconcile the static SVGs (public/fig/*.svg) vs the generated graphs.

Preview of the current site: https://danielkellerm.github.io/iDMA/ (fork).

…raphs

Add an architecture/hierarchy page wired to the ast2dot-generated graphs
and an idma_doc_site target that copies doc/fig/graph PNGs into the site.
Starting point for refreshing the docs to the current repo state.
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