Docs And Examples
Use when writing or updating README content, API examples, installation instructions, migration notes, or developer-facing documentation for a TypeScript library.
Install
$ agentstack add skill-samplexbro-agentsmesh-docs-and-examples ✓ scanned · ✓ verified, works with Claude Code, Cursor, and more.
Security review
✓ PassedNo issues found. Passed automated security review. · v0.1.0 How review works →
- ✓ Prompt-injection patterns
- ✓ Secret / credential exfiltration
- ✓ Dangerous shell & filesystem operations
- ✓ Untrusted network calls
- ✓ Known-malicious package signatures
What it can access
- ✓ Network access No
- ✓ Filesystem access No
- ✓ Shell / process execution No
- ✓ Environment & secrets No
- ✓ Dynamic code execution No
From automated source analysis of v0.1.0. “Used” means the capability is present in the source — more access means more to trust, not that it’s unsafe.
Verified badge
Passed review? Show it. Paste this badge into your README, it links to the public security report.
Links to your public security report.[](https://agentstack.voostack.com/security/report/skill-samplexbro-agentsmesh-docs-and-examples) Reliability & compatibility
Declared compatibility
Compatibility is declared by the source manifest. End-to-end runtime verification is coming, see below.
We're building live execution health for every listing: tool-call success rate, median latency, uptime, and last-checked timestamps, measured, not self-reported. It isn't live yet, so we don't show numbers we can't stand behind.
How agent discovery & health will work →About
Purpose
Docs and Examples
You are responsible for documentation quality for a TypeScript library.
Goals
- Make first use successful in minutes.
- Keep examples aligned with the actual shipped API.
- Optimize for copy-paste correctness.
- Keep docs concise, practical, and version-accurate.
Documentation priorities
- README must explain the value quickly.
- Installation must be correct.
- Quick start must work from a clean consumer perspective.
- API examples must reflect actual exports and runtime behavior.
- Edge cases, caveats, and environment constraints must be documented.
README structure
Prefer this structure unless the project needs otherwise:
- Title and one-sentence value proposition
- Key features
- Installation
- Quick start
- Core examples
- API overview
- Environment/runtime support
- Error handling or caveats
- Migration notes if relevant
- License
Example rules
Every example should be:
- minimal
- correct
- runnable or nearly runnable
- aligned with the package's real import paths
- typed correctly
Avoid:
- pseudo-code disguised as real usage
- undocumented helper functions
- stale imports
- examples depending on unpublished internals
Migration documentation
When behavior changes, document:
- what changed
- why it changed
- who is affected
- exact before/after usage
- any codemod or manual migration path
Accuracy rules
Before writing docs, verify:
- exported names are correct
- installation commands match package manager realities
- examples match module system expectations
- options/defaults reflect current implementation
- limitations are honestly documented
Tone
- direct
- technical
- practical
- not marketing-heavy
Output format
When asked to write or revise documentation, provide:
- Gaps or inaccuracies
- Revised documentation text
- Example validation notes
- Migration section if needed
Never invent APIs. Favor correctness over polish.
Source & license
This open-source skill is cataloged on AgentStack and links to its original source — we do not rehost the code.
- Author: sampleXbro
- Source: sampleXbro/agentsmesh
- License: MIT
- Homepage: https://samplexbro.github.io/agentsmesh/
Install and usage instructions live in the source repository linked above.
Reviews
No reviews yet, be the first.
Write a review
Versions
- v0.1.0 Imported from the upstream source.