smello-maintain-docs

Maintains Smello MkDocs documentation including integration guides, landing page, and configuration pages.

78|Updated Feb 16, 2026
One-click install
npx skills add https://github.com/smelloscope/smello --skill smello-maintain-docs-smelloscope
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: smello-maintain-docs
Source: https://github.com/smelloscope/smello/tree/main/.claude/skills/smello-maintain-docs
Command: npx skills add https://github.com/smelloscope/smello --skill smello-maintain-docs-smelloscope

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Keeping a documentation site consistent is tedious: new integration guides must follow an established template, nav entries must be updated in mkdocs.yml, landing page cards must link correctly, and screenshots must be generated for every guide. This Skill encodes all of those conventions so documentation changes stay uniform. ## Core Features & Use Cases - Integration guide authoring: Creates new docs/guides/debug-{name}.md pages following the project's guide template, with example script links, dashboard and Claude Code screenshots, and shared snippet includes. - Site structure updates: Updates mkdocs.yml nav, docs/guides/index.md categories, and landing page integration cards in docs/overrides/home.html. - Style enforcement: Applies the project's writing rules (sentence case headings, active voice, no em dashes, no marketing words) and builds with zensical instead of raw MkDocs. - Use Case: When you say "add a guide for debugging httpx requests", the Skill checks existing guides and example scripts, writes the new guide, wires it into the nav and index, and verifies the site builds. ## Quick Start Ask the agent to add a new integration guide for a Python library to the Smello docs and update the navigation and landing page accordingly.

Frequently Asked Questions about smello-maintain-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I add a new integration guide to the Smello docs?

Create a new `docs/guides/debug-{name}.md` file following the existing guide template, add it to `docs/guides/index.md` under the right category, and register it in the `nav:` section of `mkdocs.yml`. Check `examples/python/` for a matching example script to link, then build with `uv run zensical build`.

How do I update the Smello documentation landing page?

Edit `docs/overrides/home.html`, a Jinja2 template extending MkDocs Material. Integration cards are anchor tags linking to `guides/debug-{name}/` with white SVG logos stored in `docs/assets/logos/`.

Can I use mkdocs build directly for the Smello docs site?

No. The project uses `zensical` as its build tool, so run `uv run zensical build` or `uv run zensical serve` instead of calling `mkdocs build` or `mkdocs serve` directly.

What writing style rules apply to Smello documentation?

Use sentence case headings, active voice, and colons instead of em dashes. Avoid words like delve, leverage, seamless, robust, and marketing superlatives. Lead with `smello run` as the primary integration path.

Where do screenshots for Smello guides go?

Screenshots go in `docs/guides/assets/` and are referenced with relative paths. Each guide needs a dashboard screenshot and a Claude Code screenshot, generated with the smello-screenshot-maker skill.