Every premium and members-only resource for $9.99/month, as a no-commitment subscription. See the plans

PalateKit

Sign in
Menu

Request a resource

Describe the resource you are missing in one sentence. We will email you when it is published.

0 / 280

A page, a video or an image online.

Unlock PalateKit

Unlock everything

Plan

Paying means accepting our terms of sale.

Secure payment by Stripe. Receipts and invoices sent by email.

Welcome back

Sign in to install, download or save this resource. A free account is enough for free resources.

Reviewing docs against the code for consistency v1.0.0

Use this resource to find documentation passages that no longer match the code

New

  • 344 downloads
  • 175 likes
  • 170 saves

Free

Install with the CLI

In a terminal, from the folder you want:

npx --yes palatekit@latest install docs-code-consistency-review

With no option, the skill goes to ~/.agents/skills/; add --agent claude-code (or codex, cursor…) to target an agent.

First time: connect the CLI with

npx --yes palatekit@latest login

The agent goes through the README and the docs folder, then checks each statement against the code, configuration and API contracts. When they conflict, the code wins, and each gap points to a precise location. You get a list of issues ranked by severity.

Mostly picked by

Updated November 2, 2026

Card for the “Reviewing docs against the code for consistency” skill

Details

Works in
Install guides
Generates with
Your agent's model
Licence
MIT

Similar resources

View all

What you get

  • SKILL.md: review method and priority rules
  • checklist.md: checklist of documents to verify
  • output-format.md: expected report format

Good fit for

  • Your README describes a configuration that has changed
  • You want to check the API docs before a release

Not for

    Tags

    • documentation
    • consistency
    • review
    • readme
    • api

    About

    You say

    “Check whether the README and the docs folder still match the code.”

    Card for the “Reviewing docs against the code for consistency” skill

    Skill published by heyvhuang under the MIT license, delivered in its original version.

    Show more

    How to use it

    1. Install the skill in your agent's skills folder
    2. Ask your agent to find documentation passages that no longer match the code
    3. Review and adjust the result

    Content preview

    Files

    • checklist.md4.6 KB
    • LICENSE1 KB
    • NOTICE-PALATEKIT.md0.5 KB
    • output-format.md3.8 KB
    • SKILL.md3.6 KB

    Origin and licence

    Listed unmodified

    Author
    heyvhuang
    Source
    github.com/heyvhuang/ship-faster/tree/64047d24e0ecb513a5aa879767d95ec7e0e44462/skills/review-doc-consistency
    Licence
    MIT

    Notice

    « review-doc-consistency » (heyvhuang, MIT) livré dans sa version d'origine : fiche en français et en anglais par PalateKit.

    User reviews

    –

    No ratings yet

    Loading reviews…

    Delete your review?

    Your rating and comment will be removed from the page.