Contributing

Thanks for helping improve Standard Kernels.

Documentation locations

User-facing documentation is maintained in:

/Users/jess-sk/Documents/Projects/productionizing-standardkernels/standardkernels/docs

These pages are built with MkDocs and describe the public package: installation, usage, supported kernels, and the Python API. Keep examples copyable and avoid documenting private implementation details here.

Developer-facing documentation is internal. Design notes, experiment logs, benchmark investigations, and private STAR reports belong outside the library's public docs/ tree, for example in the workspace-level worklogs/ directory.

Preview the user-facing docs

From the library repository, install the documentation dependencies and start a local live-reload server:

python -m pip install -r docs/requirements.txt
mkdocs serve -f docs/mkdocs.yml

Keep that command running while editing. MkDocs watches the Markdown files and the package source, rebuilds after each save, and asks the browser to reload the changed page automatically. Open the local URL printed by MkDocs, usually http://127.0.0.1:8000/.

Before opening a change for review, build with strict checks:

mkdocs build -f docs/mkdocs.yml --strict

Making a documentation change

Use a focused branch and keep public documentation changes close to the API or behavior they describe. Include a runnable example when introducing a new user workflow, and update the navigation in docs/mkdocs.yml when adding a page.