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.

Building READMEs from doc comments v1.0.0

Use this resource to build a project README from its doc comments and templates

New

  • 595 downloads
  • 151 likes
  • 181 saves

Free

Install with the CLI

In a terminal, from the folder you want:

npx --yes palatekit@latest install readme-generation-from-doc-comments

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 sets up the README template, configures doc.json, generates per-package READMEs from doc comments and assembles the root README. It can plan writing tasks and verify edits with plan drift. You get a complete README that matches the code.

Mostly picked by

Updated November 2, 2026

Card for the “Building READMEs from doc comments” skill

Details

Works in
Install guides
Generates with
Your agent's model
Licence
Apache-2.0

Similar resources

View all

What you get

  • SKILL.md: file locations, doc.json configuration and generation steps
  • SKILL.md: static content, writing plan and assembly

Good fit for

  • Your README is outdated and no longer reflects the monorepo's packages
  • You want to generate package documentation from code comments

Not for

    Tags

    • readme
    • documentation
    • doc comments
    • monorepo
    • assembly

    About

    You say

    “Generate the READMEs of my packages from their comments, then assemble the root README.”

    Card for the “Building READMEs from doc comments” skill

    Skill published by trkbt10 under the Apache-2.0 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 build a project README from its doc comments and templates
    3. Review and adjust the result

    Content preview

    Files

    • LICENSE10.6 KB
    • NOTICE-PALATEKIT.md0.5 KB
    • SKILL.md9.8 KB

    Origin and licence

    Listed unmodified

    Author
    trkbt10
    Source
    github.com/trkbt10/indexion-skills/tree/7ad5ad35a6688db2f8765c1b270c9f6473da3a51/skills/indexion-readme
    Licence
    Apache-2.0

    Notice

    « indexion-readme » (trkbt10, Apache-2.0) 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.