rewrite-python-docs
Rewrite Python Docs
Use source code as the source of truth. Treat existing docs, docstrings, tests, and examples only as weak hints.
Guidelines
- Inspect
pyproject.toml,zensical.toml,noxfile.py,.config/mise/, public exports, source code, and tests before editing. - Run
scripts/gen-ref-pages.pyto regenerate reference pages underdocs/reference/. The script will output a navigation table that can be copy-pasted intozensical.toml. - Files to update:
- docstrings in source code
docs/(excluding generateddocs/reference/)- description in
pyproject.tomlandzensical.toml - inventories in
zensical.tomlif needed
- DO NOT EDIT:
- generated reference pages under
docs/reference/
- generated reference pages under
- Existing docs, docstrings, tests, examples may be rough, missing, incomplete or misleading, it only serves as weak hint.
- Favor bold, comprehensive rewrites over minor or incremental edits.
- Keep docs concise, fluent, example-first.
- Source code is the source of truth.
More from liblaf/skills
write-root-readme
Write or rewrite the repo-root README.md.
58write-python-tests
Write or refresh Python test coverage. Use when Codex needs to add coverage, replace stale tests, prefer executable doctest examples in public docstrings, or lock down Python behavior in repos that use `uv`, `pytest`, `nox`, and `mise`.
56automate-project-maintenance
Orchestrate repository maintenance. Use when Codex needs one entry point to refresh tests, docs, README, and GitHub metadata.
56write-conventional-commit
Generate exactly one high-quality Conventional Commit message from the current Git diff. Use when Codex needs to inspect staged changes, summarize the dominant intent, and return only the final commit message with no analysis or extra text.
55sync-github-repo-metadata
Inspect a repository and propose or apply GitHub About metadata updates. Use when Codex needs to infer a concise repository description and topic set from source code, package metadata, docs config, or the current README, then preview and optionally run `gh repo edit`.
55