Template documentation¶

Everything under docs/template_documentation/ explains what this GitHub template gives you: onboarding after Use this template, how the repository is laid out, and how CI, packaging, docs, tests, and quality tools are wired.

It is separate from the pages you will keep for your real package at the root of docs/ (for example the home page, API, Contributing, and Security). Those are placeholders you evolve while you ship your library.

When you can remove this directory¶

Once you no longer need the walkthroughs:

1. Delete docs/template_documentation/ entirely.
2. In zensical.toml, remove the Template documentation entry from the nav list (the whole nested block).

Your published site will then only show the durable docs you maintain for your package.

Contents¶

Onboarding¶

For the first hours after creating a repo from the template:

• Using this GitHub template — overview
• Template quick start
• Customize and clean up

User guide¶

How this repository is set up and how to work with it:

• Installation
• Quick start
• Project structure
• Development tools
• Testing
• Documentation (Zensical)
• CI/CD and releases
• Packaging
• Customization

Development notes¶

Deeper detail on quality and releases:

• Code quality
• Changelog (git-cliff)
• Troubleshooting