AGENT SKILL

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.

License 许可
MIT
所属仓库
microsoft/wassette
最近更新
2026-11-13
Stars
★ 976
Forks
78

01 前言 Front Matter

name
documentation
description
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.
allowed-tools
Bash, Read, Write, Edit, Glob, Grep

02 资源文件 2

03 SKILL.md 正文

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.

04 同仓库更多 Skills

microsoft
microsoft/wassette

rust-code-style

Write idiomatic, well-structured Rust for Wassette — single-responsibility design, anyhow error handling, Arc/Mutex for shared state, and the required formatting and linting with cargo +nightly fmt, cargo clippy, and cargo machete. Use when adding or refactoring Rust code in this repository.

开发工程师
★ 976
microsoft
microsoft/wassette

pull-request

Write concise, focused pull request descriptions for Wassette — at most three sentences on the what and why, with an explicit note on any breaking public-API change and how users adapt. Use when opening or editing a Wassette pull request.

代码审查
★ 976
microsoft
microsoft/wassette

mcp-inspector-testing

Validate Wassette changes end-to-end by running the MCP server with just and driving it with the MCP Inspector CLI over Streamable HTTP — listing tools, resources, and prompts, and calling tools. Use before committing server changes or when debugging tool exposure and behavior.

测试与质量Skill与智能体开发
★ 976
microsoft
microsoft/wassette

copyright-headers

Ensure every Rust (.rs) file in Wassette starts with the required Microsoft copyright header, using the idempotent scripts/copyright.sh helper. Use when adding new Rust files or when a copyright-header check fails.

★ 976
microsoft
microsoft/wassette

build-and-test

Build the Wassette workspace and run its test suite with the just recipes — debug and release builds, example and test components, and the combined unit plus documentation tests. Use when compiling Wassette, building example components, or running and debugging tests.

测试与质量
★ 976