跳到正文
cccskills
免费在 GitHub 公开

prose

Use this skill to write long-form Markdown guides for Topcoat. It covers where documentation sources belong, how to structure explanations from basic to advanced, and how to keep prose plain, concise, and easier to maintain as implementations change.

中文简介正在准备中。当前显示英语简介。

原文查看原文说明

Always use this skill before writing long form markdown documentation for Topcoat.

tokio-rs/topcoat星标 6,226(GitHub 6,226 + cccskills 0)

实测评分 未实测

查看安装方法

适用场景

  • Planning where a guide and its links should live
  • Structuring a guide from basic to advanced use
  • Editing Markdown for clear, maintainable prose

包含的文件(1)

  • SKILL.md1.6 KB

SKILL.md(原文)

安装前可以查看交给 AI 代理的指令内容。

Prose

Placement

Put guide sources in the top-level docs/ directory, following the module structure. For example, use docs/router.md, docs/router/module.md, and docs/router/content/sse.md. Crate-local docs/ files must be relative symlinks to those sources, with the crate module prefix omitted. The facade crate keeps the full module paths. Embed documentation through the crate-local path with #[doc = include_str!("../docs/file.md")] so published crates include it. Edit the top-level source and link to it from README.md and AGENTS.md where appropriate.

Structure

When writing a guide, start with a very simple summary of what the guide is about, potentially linking to resources (e.g. Tailwind website). Then carefully introduce basic usage before moving on to more advanced topics.

When a feature is already best explained in detail by another part of the documentation (e.g. another markdown file), explain it at most briefly and then refer the reader to the related docs file via a Rust docs link.

General

  • Write in plain english. No fancy sentence structure.
  • Avoid exhaustively listing specific implementations or uses that could evolve over time and go stale.
  • Use only ASCII characters in both code and documentation, e.g. -> instead of unicode arrow or ... instead of ellipsis character.
  • Avoid em-dashes entirely. Use colons and semicolons sparingly.
  • Keep individual paragraphs in a markdown file on a single line.

评价

还没有评价。欢迎分享你的使用感受。

评论

无需登录即可发表。欢迎分享使用感受、提问,或说明在哪些环境下无法运行。

还没有评论。来写第一条吧。

提交后会立即公开。请勿填写邮箱、电话等个人信息。URL 最多 2 个。

0 / 1000 字

此表单受 reCAPTCHA 保护,适用 Google 的隐私权政策和服务条款。

同一仓库的技能

check

免费

Use this skill to check Topcoat changes locally before committing or opening a pull request. It runs the project’s Rust formatting, lint, test, and documentation commands, plus browser project checks when relevant, so problems can be caught before review.

中文简介正在准备中。当前显示英语简介。

  • Checking a Rust change before committing
  • Validating browser project changes
  • Building project documentation locally
tokio-rs/topcoat62262026年10月25日 更新

commit

免费

Use this skill to write concise commit messages in the Topcoat project’s Conventional Commits format. It helps choose a change type and scope, describe the update clearly, and mark breaking changes so release notes and version bumps can be based on commit history.

中文简介正在准备中。当前显示英语简介。

  • Writing a commit message for a code change
  • Choosing a commit type and scope
  • Marking a breaking change and migration note
tokio-rs/topcoat62262026年10月25日 更新

macro

免费

Use this skill when building procedural macros for Topcoat in Rust. It explains how to preserve parsed syntax in AST nodes, separate parsing from meaning, and keep macro entry points focused on parsing input, expanding valid code, and reporting errors.

中文简介正在准备中。当前显示英语简介。

  • Designing AST nodes for a procedural macro
  • Parsing custom syntax while preserving tokens
  • Organizing a macro entry point and code generation
tokio-rs/topcoat62262026年10月25日 更新

pr

免费

Use this skill to prepare a Topcoat pull request from the full branch diff. It guides you to write a Conventional Commits title and a concise body covering the change, verification performed, and an AI-use disclaimer when an agent creates the PR.

中文简介正在准备中。当前显示英语简介。

  • Writing a pull request title from the net branch change
  • Summarizing a diff and the checks performed
  • Adding the required AI-use disclosure to a PR
tokio-rs/topcoat62262026年10月25日 更新

style

免费

Apply the project’s Rust conventions when editing code or documentation. The guidance covers module and type organization, workspace dependency declarations, plain English documentation, and tests that check meaningful behavior rather than fixed text.

中文简介正在准备中。当前显示英语简介。

  • Organizing Rust modules and implementations
  • Writing or revising Rust documentation
  • Reviewing whether a test protects real behavior
tokio-rs/topcoat62262026年10月25日 更新

查看 tokio-rs 的全部技能

报告此技能的问题