LLMSkillHub
mirroredCopied from microsoft/wassette under MIT. microsoft has not claimed this page, and is not affiliated with LLM SkillHub.

microsoft / documentation

Build, serve, and write Wassette's mdBook documentation under docs/ — concise, code-first prose, the multi-version URL layout, and navigation in SUMMARY.md. Use when editing docs/ pages or previewing the documentation site.

0
SKILL.md
1.7 KB

documentation skill

Wassette documentation lives under docs/ and is built with
mdBook.

Build and serve

just docs-build    # Build static HTML to docs/book/
just docs-watch    # Serve at http://localhost:3000 with live reload
just docs-serve    # Serve and open in the browser

Or directly: cd docs && mdbook serve / mdbook build.

URL structure

Production uses a multi-version layout that mdbook serve does not reproduce
locally:

  • Local: open http://localhost:3000/overview.html (or a specific page).
    The version picker and the root redirect only work in production.

  • Production: https://microsoft.github.io/wassette/latest/ (and
    /v0.3.0/ for releases).

Writing style

  • Prefer working code examples over long prose; explain details second.
  • Keep pages focused and concise; every sentence should add value.
  • Use active voice and present tense; define acronyms on first use.
  • Always set the language on code blocks; use descriptive link text.

Visual changes

Preview layout or presentation changes locally. Include screenshots when they
help reviewers understand a meaningful visual difference.

Adding a page

  1. Create the markdown file in the right docs/ subdirectory.
  2. Register it in docs/SUMMARY.md so it appears in navigation.
  3. Match existing structure and formatting; test all links.
  4. Preview locally with just docs-serve.