본문으로 건너뛰기
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,234(GitHub 6,234 + 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(원문)

설치하기 전에 에이전트에게 전달되는 지시 내용을 확인할 수 있습니다.

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 / 1,000자

이 양식은 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/topcoat6.2천2026년 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/topcoat6.2천2026년 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/topcoat6.2천2026년 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/topcoat6.2천2026년 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/topcoat6.2천2026년 10월 25일 업데이트

tokio-rs의 스킬 모두 보기

이 스킬의 문제 신고