Repository navigation
Conversation
Swap the zensical build engine for mkdocs: update Makefiles and CI step names, drop the zensical dependency and its markdown-extension shim (the badges mkdocs plugin covers rendering), and fold the blog nav into the Material blog plugin's generated navigation.
- e2s-docs-light now only runs on pushes touching docs content (including blog posts), the examples/recipes sources, the docs toolchain, or the pipeline itself; other pushes skip the H100 docs rebuild. Use workflow_dispatch to force a rebuild after docstring-only changes. - Add codespell pre-commit hook over hand-written docs (README, mkdocs.yml, non-generated docs/*.md) and wire it into 'make lint' for CI.
Contributor
Greptile SummaryConverts documentation builds from Zensical back to MkDocs Material and simplifies blog generation, while narrowing automatic light-doc rebuilds and adding documentation spell-checking.
|
| Filename | Overview |
|---|---|
| .github/workflows/e2s-docs-light.yml | Narrows automated documentation deployments to selected documentation and toolchain paths; omitted source-only documentation updates are explicitly documented. |
| Makefile | Replaces Zensical documentation commands with equivalent MkDocs build and serve commands and adds codespell to linting. |
| docs/Makefile | Updates standalone documentation targets and variables from Zensical to MkDocs. |
| mkdocs.yml | Removes the Zensical badge extension, enables expanded navigation, and delegates blog navigation generation to the Material blog plugin. |
| .pre-commit-config.yaml | Adds codespell for hand-written Markdown documentation while excluding generated documentation trees. |
| pyproject.toml | Removes Zensical from the documentation dependency group. |
| uv.lock | Synchronizes the lock metadata by removing the Zensical documentation dependency. |
| docs/blog/.authors.yml | Defines author metadata referenced by the two updated blog posts. |
| docs/blog/index.md | Removes the hand-written post listing so the configured Material blog plugin can generate it. |
Reviews (1): Last reviewed commit: "Scope docs CI to docs changes and add co..." | Re-trigger Greptile
This branch has not been deployed
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.
Earth2Studio Pull Request
Description
Converts the documentation build from zensical back to mkdocs-material and
cleans up the blog and docs CI:
zensical build/serve→mkdocs build/servein the Makefiles andCI action; drop the
zensicaldependency and themkdocs_badges.zensicalmarkdown extension (the
badgesmkdocs plugin provides the same rendering).This also aligns the local/artifact build with what
mike deployhas beenpublishing all along.
category pages instead of hand-written listings; add post authors via
docs/blog/.authors.yml.navigation.expand).e2s-docs-lightnow only runs when docs content (including blogposts), examples/recipes, the docs toolchain, or the pipeline itself
changes — other pushes skip the H100 docs rebuild (
workflow_dispatchstill forces one, e.g. after docstring-only changes).
codespellpre-commit hook over hand-written docs(README, mkdocs.yml, non-generated
docs/**/*.md) and wire it intomake lint.Verified:
make docsend-to-end,uv lock --check, badge autosummary/filterrendering, blog author rendering, sitemap, and mike compatibility.
Known follow-up:
docs/blog/archive.md,docs/blog/categories.md, anddocs/blog/categories/documentation.mdare now orphaned duplicates of theplugin-generated pages and should be deleted.
Checklist
Dependencies
Removes
zensical; no new dependencies (codespell runs via pre-commit).🤖 Generated with Claude Code