ChatGPT readme-style skill for a repository documentation hub
Turn a supplied README excerpt and file inventory into a technical overview, repository map, and documentation index, marking claims that need verification.
中文Install in ChatGPT
In a ChatGPT workspace with skill creation enabled, manually select the skill. Provide the README excerpt, repository inventory, and verified notes as plain text.
- In a ChatGPT workspace with skill creation enabled, open Plugins → Skills → Create → Create with editor.
- Create a skill in the editor and adapt the text-only `readme-style` workflow from the pinned GitHub source into its instructions.
- Save the skill, then type @ in a new chat to select it and try the example.
Example task
Manually select readme-style and use this fictional repository inventory to draft a README focused on navigation and its module map.
project `Seedling Notes` | confirmed feature `offline notebooks`
existing files `src/index.ts` and `docs/setup.md` | missing file `docs/install.md`
current README points its setup entry to `docs/install.md` | requested scope=overview, repository map and docs indexWhat to check
Name the verified `offline notebooks` feature in the overview and put `src/index.ts` in the repository map. Point setup to `docs/setup.md` and note that `docs/install.md` is absent from the inventory.
Original SKILL.md on GitHub · Updated
Frequently asked question
How should I handle a quick-start step I have not verified?
Mark it as pending verification. Include only evidenced steps in the quick start and check documentation links against the inventory.