# Docs And Examples

> Use when writing or updating README content, API examples, installation instructions, migration notes, or developer-facing documentation for a TypeScript library.

- **Type:** Skill
- **Install:** `agentstack add skill-samplexbro-agentsmesh-docs-and-examples`
- **Verified:** Yes — security-reviewed for prompt injection and unsafe behavior
- **Seller:** [sampleXbro](https://agentstack.voostack.com/s/samplexbro)
- **Installs:** 0
- **Category:** [Agent Skills](https://agentstack.voostack.com/c/agent-skills)
- **Latest version:** 0.1.0
- **License:** MIT
- **Upstream author:** [sampleXbro](https://github.com/sampleXbro)
- **Source:** https://github.com/sampleXbro/agentsmesh/tree/master/.agents/skills/docs-and-examples
- **Website:** https://samplexbro.github.io/agentsmesh/

## Install

```sh
agentstack add skill-samplexbro-agentsmesh-docs-and-examples
```

Requires the [AgentStack CLI](https://agentstack.voostack.com/docs/cli). Works with Claude Code, Cursor, and any MCP-compatible agent.

## 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

1. README must explain the value quickly.
2. Installation must be correct.
3. Quick start must work from a clean consumer perspective.
4. API examples must reflect actual exports and runtime behavior.
5. 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:
1. Gaps or inaccuracies
2. Revised documentation text
3. Example validation notes
4. 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](https://github.com/sampleXbro)
- **Source:** [sampleXbro/agentsmesh](https://github.com/sampleXbro/agentsmesh)
- **License:** MIT
- **Homepage:** https://samplexbro.github.io/agentsmesh/

Install and usage instructions live in the source repository linked above.

## Pricing

- **Free** — Free

## Security capabilities

Automated source analysis of v0.1.0 — what this tool can access:

- **Network access:** no
- **Filesystem access:** no
- **Shell / process execution:** no
- **Environment & secrets:** no
- **Dynamic code execution:** no

*"Yes" means the capability is present in the source — more access means more to trust, not that it is unsafe.*


## Versions

- **0.1.0** — security scan: passed — Imported from the upstream source.

## Links

- Listing page: https://agentstack.voostack.com/l/skill-samplexbro-agentsmesh-docs-and-examples
- Seller: https://agentstack.voostack.com/s/samplexbro
- Browse the marketplace: https://agentstack.voostack.com/browse

---
Listed on AgentStack — the marketplace for AI agent skills and MCP servers. Every listing is security-reviewed. Creators keep 70%.