-
Notifications
You must be signed in to change notification settings - Fork 5
Simplify Documentation Stack: Remove mkdocstrings and gen-files #138
Description
As the project evolves, we should simplify our documentation stack to remove the maintenance burden of auto-generated API docs and prepare for a future Zensical migration. ruff-sync is a CLI tool, and the auto-generated API reference (gen-files + mkdocstrings) is low value compared to hand-authored documentation that focuses on the CLI interface and core integration points.
Tasks
-
Remove Dependencies
Removemkdocstringsandmkdocs-gen-filesfrompyproject.tomlunder[dependency-groups.docs]. -
Delete Generation Scripts
Delete the filedocs/gen_ref_pages.py. This script is currently used bygen-filesto discover and generate API pages. -
Update
mkdocs.ymlPlugins
Remove thegen-filesandmkdocstringsplugins from theplugins:block inmkdocs.yml.
# Remove these:
- gen-files:
scripts:
- docs/gen_ref_pages.py
- mkdocstrings:
handlers:
python:
paths: [src]
# ... (options)- Create Hand-Authored API Reference (
docs/reference/api.md)
Create a new filedocs/reference/api.mdthat provides a high-level summary of theruff-syncCLI and core library. It should include:
- CLI Commands: A summary of
pull,check, andinitcommands (useruff-sync --helpas a guide). - Core Result Types: A brief overview of the
Config(TypedDict) andFetchResult(NamedTuple) fromsrc/ruff_sync/core.py. - Main Entry Point: Mention that the core logic resides in
ruff_sync.core.syncor thecli.mainfunction.
- Update Navigation
Inmkdocs.yml, update thenav:block so that "API Reference" points directly to the newapi.mdfile:
nav:
- ...
- API Reference: reference/api.mdValidation
- Run
uv run mkdocs buildand ensure the site builds without errors and the new API Reference page is correctly rendered.