Toutes les ressources premium et membres pour 8,99 €/mois, en abonnement sans engagement. Voir les offres

PalateKit

Menu

Demander une ressource

Décrivez en une phrase la ressource qui vous manque. Nous vous écrirons quand elle sera publiée.

0 / 280

Débloquer PalateKit

Tout débloquer

Offre

Le paiement vaut acceptation de nos conditions générales de vente.

Paiement sécurisé par Stripe. Reçus et factures envoyés par e-mail.

Content de vous revoir

Connectez-vous pour installer, télécharger ou sauvegarder cette ressource. Un compte gratuit suffit pour les ressources gratuites.

Construction du README à partir des commentaires de code v1.0.0

Utilisez cette ressource pour construire le README d'un projet à partir de ses commentaires et de ses modèles

Nouveau

  • 595 téléchargements
  • 151 mentions J'aime
  • 181 sauvegardes

Gratuit

Installer avec la CLI

Dans un terminal, depuis le dossier voulu :

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

Sans option, la skill va dans ~/.agents/skills/ ; ajoutez --agent claude-code (ou codex, cursor…) pour viser un agent.

Première fois : connectez la CLI avec

npx --yes palatekit@latest login

L'agent prépare le modèle de README, configure doc.json, génère les README par paquet depuis les commentaires de documentation et assemble le README racine. Il peut planifier les rédactions et vérifier les modifications avec plan drift. Vous obtenez un README complet et cohérent avec le code.

Choisie surtout par

Mise à jour le 2 novembre 2026

Carte de la skill « Construction du README à partir des commentaires de code »

Caractéristiques

Guides d'installation
Génère avec
Le modèle de votre agent
Licence
Apache-2.0

Ressources similaires

Tout voir

Ce que vous obtenez

  • SKILL.md : emplacements des fichiers, configuration doc.json et étapes de génération
  • SKILL.md : rédaction des contenus statiques, plan de rédaction et assemblage

Pour qui

  • Votre README est ancien et ne reflète plus les paquets du monorepo
  • Vous voulez générer la documentation des paquets à partir des commentaires

Pas pour qui

    Étiquettes

    • readme
    • documentation
    • commentaires
    • monorepo
    • assemblage

    À propos

    Vous dites

    « Génère les README de mes paquets à partir des commentaires, puis assemble le README racine. »

    Carte de la skill « Construction du README à partir des commentaires de code »

    Skill publiée par trkbt10 sous licence Apache-2.0. Fichiers livrés dans leur version d'origine, en anglais.

    Voir plus

    Comment l'utiliser

    1. Installez la skill dans le dossier de skills de votre agent
    2. Demandez à votre agent de construire le README d'un projet à partir de ses commentaires et de ses modèles
    3. Relisez et ajustez le résultat

    Aperçu du contenu

    Fichiers

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

    Origine et licence

    Référencée sans modification

    Auteur
    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.

    Avis des utilisateurs

    –

    Aucune note pour l'instant

    Chargement des avis…

    Supprimer votre avis ?

    Votre note et votre commentaire seront retirés de la fiche.