packages-documentation SKILL.md skillA

packages-documentation from reactive/data-client is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.

Install it, pinned
mdr add reactive/data-client/packages-documentation@git:20261031.aed5598

Pins git:20261031.aed5598 in mdr.lock. Pin the fingerprint instead.

Audit grade
A, 17 of 17 checks passed
Kind
SKILL.md skill
Repository
reactive/data-client
Path
.agents/skills/packages-documentation/SKILL.md
Versions recorded
6
Latest version
git:20261031.aed5598, committed Oct 31, 2026
First version recorded
Oct 3, 2026
Size
5,620 bytes
Repository stars
2,040
License
Apache-2.0

Write, update, and format documentation for @data-client public APIs - API reference (Docusaurus/MDX), README files, JSDoc/TSDoc docstrings, usage examples, migration guides, deprecation notices, changelog entries. Use when changing exported APIs (docs must update in the same PR), writing new package docs, or updating the dataclient.io site.

Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.

What the file says

# Package Documentation Writing Guidelines

This guide covers how to write and format documentation for public library interfaces.

## Documentation Structure

The `/docs` folder is organized by package:
- `docs/core/` - Documentation for `@data-client/core`, `@data-client/react` and `@data-client/vue`
- `docs/rest/` - Documentation for `@data-client/rest`
- `docs/graphql/` - Documentation for `@data-client/graphql`

Each package documentation has subdirectories:
- `api/` - API reference documentation (one file per public class/function/hook)
- `guides/` - How-to guides and tutorials
- `concepts/` - Conceptual documentation
- `getting-started/` - Getting started guides

## React and Vue (single source)

`docs/core` renders twice: React at `/docs`, Vue at `/vue`. Never copy a page to make a Vue version.
Wrap framework-specific content instead, so shared prose and resources stay in one place:

- `:::react` / `:::vue` blocks (use `::::` on an outer admonition that contains them)
- `:react[...]` / `:vue[...]` for inline words or links
- `<FrameworkPlayground>` instead of `<HooksPlayground>`, with shared resource code blocks
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint
mdr add reactive/data-client/packages-documentation@sha256:35819d2368881b31

The line at the top of this page pins the label git:20261031.aed5598, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.

Badge

mdr badge

[![mdr](https://markdownregistry.com/badge/art_jinyfrsxpyzbbkvd.svg)](https://markdownregistry.com/a/art_jinyfrsxpyzbbkvd)

2 badge image fetches in 30 days. What the badge shows.

Versions

The registry has recorded 6 versions of this file, between Oct 3, 2026 and Oct 31, 2026, about one every 6 days.

versioncommittedcommitsizeaudit
git:20261031.aed5598 latest2026-10-31 aed5598 5,620 BA view · diff
git:20261005.1bb231b2026-10-05 1bb231b 5,525 BA view · diff
git:20261005.0bf4bc62026-10-05 0bf4bc6 5,271 BA view · diff
git:20261005.3f291a62026-10-05 3f291a6 5,244 BA view · diff
git:20261003.577717a2026-10-03 577717a 5,064 BA view · diff
git:20261003.5bfb1f22026-10-03 5bfb1f2 5,069 BA view

Audit of the latest version

A  17 of 17 checks passed. Fixed automatic checks with no AI involved, so the same checks give the same answer every run.
  • pass: Frontmatter block present
  • pass: Frontmatter declares a name
  • pass: Frontmatter declares a description
  • pass: Size between 200 bytes and 200 KB (5620 bytes)
  • pass: No zero-width or bidi control characters
  • pass: No instruction hidden inside an HTML comment
  • pass: No link to an exfiltration or paste host
  • pass: No credential-shaped string
  • pass: No instruction to send local credentials anywhere
  • pass: No text hidden with inline styles
  • pass: No prompt-injection phrasing
  • pass: No curl or wget piped into a shell
  • pass: No recursive delete of root, home or parent
  • pass: No instruction to read or print local credentials
  • pass: No base64 blob over 200 characters
  • pass: No link to a raw IP address
  • pass: No script tag

Source

GitHub

reactive/data-client · 2,040 stars · license Apache-2.0 · pushed 2026-11-01 · branch master

API

GET https://markdownregistry.com/api/v1/artifacts/art_jinyfrsxpyzbbkvd
GET https://markdownregistry.com/api/v1/resolve?ref=reactive/data-client/packages-documentation
GET https://markdownregistry.com/api/v1/blob/35819d2368881b3164a280f259560c5f3e8b3617f354ccccc7c72573d8af134f

Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.

Guides: the SKILL.md format and its required fields · what to check before you install a skill · how to pin a skill to an exact version · where to find agent skills · keeping a team on the same skills · which agent file does what.

More from reactive/data-client

changeset SKILL.md skill
reactive/data-client · .agents/skills/changeset/SKILL.md · Create user-focused changesets (changelog entries) for semver bumps, release notes, breaking changes, and docs; prefer…
git:20261017.9abb86a · audit A · 2,040 stars
data-client-endpoint-setup SKILL.md skill
reactive/data-client · .agents/skills/data-client-endpoint-setup/SKILL.md · Set up @data-client/endpoint for custom async operations. Wraps existing async functions with Endpoint for use with…
git:20261023.c4091aa · audit A · 2,040 stars
data-client-graphql-setup SKILL.md skill
reactive/data-client · .agents/skills/data-client-graphql-setup/SKILL.md · Set up @data-client/graphql for GraphQL APIs. Configures GQLEndpoint with auth and custom options. Use after…
git:20261023.c4091aa · audit A · 2,040 stars
data-client-manager SKILL.md skill
reactive/data-client · .agents/skills/data-client-manager/SKILL.md · Write @data-client Managers for app-wide side effects and real-time data such as websockets, SSE and polling: code that…
git:20261027.486429b · audit A · 2,040 stars
data-client-react-testing SKILL.md skill
reactive/data-client · .agents/skills/data-client-react-testing/SKILL.md · Test React code that uses @data-client/react: components and hooks that fetch or change data, with mocked responses for…
git:20261027.486429b · audit A · 2,040 stars
data-client-react SKILL.md skill
reactive/data-client · .agents/skills/data-client-react/SKILL.md · Read, change and render async and shared state in React with @data-client/react: any data from an API or other async…
git:20261030.c82dc24 · audit A · 2,040 stars
data-client-rest-setup SKILL.md skill
reactive/data-client · .agents/skills/data-client-rest-setup/SKILL.md · Set up and migrate to @data-client/rest for REST APIs. Detects existing HTTP patterns (axios, fetch, ky, superagent…
git:20261025.4f1c324 · audit A · 2,040 stars
data-client-rest SKILL.md skill
reactive/data-client · .agents/skills/data-client-rest/SKILL.md · Define how the app talks to its API with @data-client/rest, including the shape of the data each call returns. Use it…
git:20261023.c4091aa · audit A · 2,040 stars
data-client-schema SKILL.md skill
reactive/data-client · .agents/skills/data-client-schema/SKILL.md · Model the app's data with @data-client schemas, which normalize responses into one shared cache so an update shows…
git:20261023.c4091aa · audit A · 2,040 stars
data-client-setup SKILL.md skill
reactive/data-client · .agents/skills/data-client-setup/SKILL.md · Install and set up @data-client/react or @data-client/vue in a project. Detects project type (NextJS, Expo, React…
git:20261021.bb0dda6 · audit A · 2,040 stars
data-client-v0.18-migration SKILL.md skill
reactive/data-client · .agents/skills/data-client-v0.18-migration/SKILL.md · Migrate @data-client codebases to v0.18 delegate signatures. Drives the v0.18 codemod and then handles the cases it…
git:20261019.7d1c42a · audit B · 2,040 stars
data-client-vue-testing SKILL.md skill
reactive/data-client · .agents/skills/data-client-vue-testing/SKILL.md · Test Vue code that uses @data-client/vue: components and composables that fetch or change data, with mocked responses…
git:20261027.486429b · audit A · 2,040 stars

Every file in reactive/data-client

Browse by kind, by grade A, or by owner.