GitHub Readme Generator
wwwzhouhui/skills_collection
Generate professional GitHub project README.md with standard structure including project intro, features, installation, usage, documentation, FAQ, contact info, donation, statistics, roadmap, and…
Repository documentation placement and writing guidance. An agent skill from jmfederico/pi-web.
Install Documentation Guide
$ npx skills add jmfederico/pi-web --skill documentation-guide -a claude-codeProject install by default; add -g for ~/.claude/skills/.
$ gh skill install jmfederico/pi-web documentation-guide --agent claude-codeProject scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).
$ git clone --depth 1 https://github.com/jmfederico/pi-web.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/documentation-guide .claude/skills/documentation-guide && rm -rf skills-srcUse ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.
Claude Code skills documentation · loads skills from .claude/skills/
Install the "documentation-guide" agent skill from https://github.com/jmfederico/pi-web/tree/main/.agents/skills/documentation-guide into .claude/skills/documentation-guide/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "documentation-guide", then confirm the skill loads.Claude Code copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$skill-installer install https://github.com/jmfederico/pi-web/tree/main/.agents/skills/documentation-guideType this inside Codex. $skill-installer <name> installs a curated skill from openai/skills. The installer writes to $CODEX_HOME/skills (default ~/.codex/skills). Restart Codex if the skill does not show up.
$ npx skills add jmfederico/pi-web --skill documentation-guide -a codexProject install goes to .agents/skills/; add -g for ~/.codex/skills/.
$ gh skill install jmfederico/pi-web documentation-guide --agent codexProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/jmfederico/pi-web.git skills-src && mkdir -p .agents/skills && cp -r skills-src/.agents/skills/documentation-guide .agents/skills/documentation-guide && rm -rf skills-srcUse ~/.agents/skills/ instead of .agents/skills for a personal install.
Codex skills documentation · loads skills from .agents/skills/
Install the "documentation-guide" agent skill from https://github.com/jmfederico/pi-web/tree/main/.agents/skills/documentation-guide into .agents/skills/documentation-guide/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "documentation-guide", then confirm the skill loads.Codex copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add jmfederico/pi-web --skill documentation-guide -a cursorProject install goes to .agents/skills/; add -g for ~/.cursor/skills/.
$ gh skill install jmfederico/pi-web documentation-guide --agent cursorProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/jmfederico/pi-web.git skills-src && mkdir -p .cursor/skills && cp -r skills-src/.agents/skills/documentation-guide .cursor/skills/documentation-guide && rm -rf skills-srcUse ~/.cursor/skills/ instead of .cursor/skills for a personal install.
Cursor skills documentation · loads skills from .cursor/skills/, .agents/skills/, .claude/skills/, .codex/skills/
Install the "documentation-guide" agent skill from https://github.com/jmfederico/pi-web/tree/main/.agents/skills/documentation-guide into .cursor/skills/documentation-guide/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "documentation-guide", then confirm the skill loads.Cursor copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gemini skills install https://github.com/jmfederico/pi-web.git --path .agents/skills/documentation-guide--scope user (default) or --scope workspace; --path is the subfolder of the repo that holds the skill; --consent skips the security confirmation prompt.
$ npx skills add jmfederico/pi-web --skill documentation-guide -a gemini-cliProject install goes to .agents/skills/; add -g for ~/.gemini/skills/.
$ gh skill install jmfederico/pi-web documentation-guide --agent gemini-cliProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/jmfederico/pi-web.git skills-src && mkdir -p .gemini/skills && cp -r skills-src/.agents/skills/documentation-guide .gemini/skills/documentation-guide && rm -rf skills-srcUse ~/.gemini/skills/ instead of .gemini/skills for a personal install, then run /skills reload.
Gemini CLI skills documentation · loads skills from .gemini/skills/, .agents/skills/
Install the "documentation-guide" agent skill from https://github.com/jmfederico/pi-web/tree/main/.agents/skills/documentation-guide into .gemini/skills/documentation-guide/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "documentation-guide", then confirm the skill loads.Gemini CLI copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gh skill install jmfederico/pi-web documentation-guideInstalls for Copilot at project scope by default; add --scope user for a personal install. Preview a skill first with gh skill preview. Needs GitHub CLI 2.90.0 or later (public preview).
$ npx skills add jmfederico/pi-web --skill documentation-guide -a github-copilotProject install goes to .agents/skills/; add -g for ~/.copilot/skills/.
$ git clone --depth 1 https://github.com/jmfederico/pi-web.git skills-src && mkdir -p .github/skills && cp -r skills-src/.agents/skills/documentation-guide .github/skills/documentation-guide && rm -rf skills-srcUse ~/.copilot/skills/ instead of .github/skills for a personal install. Commit .github/skills so cloud agent and code review can use it.
GitHub Copilot skills documentation · loads skills from .github/skills/, .claude/skills/, .agents/skills/
Install the "documentation-guide" agent skill from https://github.com/jmfederico/pi-web/tree/main/.agents/skills/documentation-guide into .github/skills/documentation-guide/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "documentation-guide", then confirm the skill loads.GitHub Copilot copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add jmfederico/pi-web --skill documentation-guide -a opencodeOpenCode documents no install command of its own. Project install goes to .agents/skills/; add -g for ~/.config/opencode/skills/.
$ gh skill install jmfederico/pi-web documentation-guide --agent opencodeProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/jmfederico/pi-web.git skills-src && mkdir -p .opencode/skills && cp -r skills-src/.agents/skills/documentation-guide .opencode/skills/documentation-guide && rm -rf skills-srcUse ~/.config/opencode/skills/ instead of .opencode/skills for a personal install.
OpenCode skills documentation · loads skills from .opencode/skills/, .claude/skills/, .agents/skills/
Install the "documentation-guide" agent skill from https://github.com/jmfederico/pi-web/tree/main/.agents/skills/documentation-guide into .opencode/skills/documentation-guide/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "documentation-guide", then confirm the skill loads.OpenCode copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
Facts
- Skill name
documentation-guide- GitHub stars
- 861
- Token cost
- ~1.7k tokens
- SKILL.md length
- 840 words
- Files
- 1
- Skills in repo
- 7
- Repo updated
- First seen
- Licence
- MIT
At a glance
Repository documentation placement and writing guidance. An agent skill from jmfederico/pi-web.
- Works in 5 steps: Does a user need this information before… → Is it a short orientation statement, or… → Is it troubleshooting, configuration,… → …
- Planning README.md
- SKILL.md covers Core rule, README contract, Choose the canonical destination and Placement decision, plus 4 more sections
- Calls git
What it does
Documentation Guide is an agent skill from jmfederico/pi-web. Repository documentation placement and writing guidance. Use this skill whenever writing, modifying, reviewing, or planning README.md, anything under docs/, setup or installation instructions, troubleshooting or FAQ content, configuration references, operational guidance, or user-facing documentation in a feature or fix. Keep the README concise and put detailed material in its canonical documentation page.
Its SKILL.md is about 1.7k tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.
It sits in Development, covering Technical documentation and Help center and FAQ content. The repository describes itself as: Web UI for Pi Coding Agent that keeps sessions alive in real workspaces. The licence is MIT.
When your agent uses it
- Planning README.md
- Anything under docs/
- Installation instructions
- Troubleshooting
Example prompts
- “/documentation-guide”
Workflow steps
5 steps, taken from the first numbered list in SKILL.md.
- Does a user need this information before their first successful run?
- Is it a short orientation statement, or does it need qualifications and examples?
- Is it troubleshooting, configuration, platform-specific, operational, or implementation detail?
- Is there already a canonical page for the topic?
- Would a link provide a clearer README than another paragraph?
What it can do on your machine
Read from SKILL.md and the folder at commit 15c13a4. It shows what the files ask for, not the result of running them.
Tool permissions
Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.
From allowed-tools in the SKILL.md frontmatter.
Runs code
Shell commands in SKILL.md call:
git
From the folder's file list and the shell code blocks in SKILL.md.
Network
No URLs in SKILL.md. Its commands use git, which can reach the network depending on how they are called.
From URLs in SKILL.md, links to its own repository left out.
Credentials
Names no API keys, tokens, secrets or passwords.
From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.
Context cost
Documentation Guide loads about 1.7k tokens when it runs. Until then it costs about 107 tokens; SKILL.md has 840 words of instructions outside code blocks.
Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.
Safety
Auto-check passed
The automated check found no risky patterns in SKILL.md.
Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.
SKILL.md
The full file from jmfederico/pi-web at commit 15c13a4, republished under its MIT licence (© jmfederico). 840 words, ~1,673 tokens.
Download SKILL.mdSave it as
.claude/skills/documentation-guide/SKILL.md (or your agent's skills folder).- name
- documentation-guide
- description
- Repository documentation placement and writing guidance. Use this skill whenever writing, modifying, reviewing, or planning README.md, anything under docs/, setup or installation instructions, troubleshooting or FAQ content, configuration references, operational guidance, or user-facing documentation in a feature or fix. Keep the README concise and put detailed material in its canonical documentation page.
Documentation guide
Use this guide to decide where documentation belongs and how much detail each surface should carry. The goal is a short, useful path for new users without losing the detailed guidance needed by operators and experienced users.
Core rule
Treat README.md as the project landing page and quick start, not the complete manual.
A reader should be able to understand what PI WEB is, decide whether it is relevant, satisfy the basic prerequisites, complete the shortest supported installation, and find the detailed documentation. Once that path is clear, additional explanation belongs under docs/.
Do not add every new feature, caveat, implementation detail, troubleshooting case, or behavioral guarantee to the README. Update the canonical detailed page and link to it when discovery from the README materially helps a new user.
README contract
The README may contain concise versions of:
- the product identity and value proposition;
- high-level capabilities that help someone decide whether to use PI WEB;
- basic runtime requirements;
- the shortest supported install and first-run path;
- essential day-to-day commands;
- the core user-facing model;
- a brief security warning needed before exposing the service;
- links to canonical documentation.
Put these elsewhere:
- installation variants, platform-specific setup, service-manager behavior, and PATH details;
- troubleshooting steps, diagnostics, failure modes, and edge cases;
- exhaustive command options or feature behavior;
- configuration schemas, precedence, defaults, and migration guidance;
- internal architecture and implementation mechanics;
- detailed plugin, machine, federation, or remote-access workflows;
- release-note-style descriptions of individual fixes and enhancements.
A feature belongs in the README only when it materially changes the top-level product story or the shortest path to a successful first run. Being user-visible by itself is not enough.
Choose the canonical destination
| Content | Canonical destination |
|---|---|
| Product overview and shortest successful start | README.md |
| Website landing-page summaries and navigation | docs/index.html |
| Requirements, installation modes, PATH setup, service managers, WSL, and manual operation | docs/install.html |
| Troubleshooting, diagnostics, known failure modes, and edge cases | docs/faq.html |
| Configuration keys, files, precedence, defaults, and reload behavior | docs/config.md and docs/config.html |
| Remote access and deployment model | docs/remote-first.html |
| Machine federation and selected-machine behavior | docs/machines.html |
| Plugin and Pi package behavior | docs/plugins.md and docs/plugins.html |
| Internal invariants that maintainers need while changing code | Focused code comments, AGENTS.md, or a dedicated developer document |
When a topic has both Markdown and HTML representations, inspect the local convention and keep user-visible claims synchronized. Do not copy large passages into multiple surfaces merely for convenience.
Placement decision
Before adding documentation, ask:
- Does a user need this information before their first successful run?
- Is it a short orientation statement, or does it need qualifications and examples?
- Is it troubleshooting, configuration, platform-specific, operational, or implementation detail?
- Is there already a canonical page for the topic?
- Would a link provide a clearer README than another paragraph?
If the content needs multiple sentences of caveats, explains how an internal mechanism works, or applies only after installation, it almost always belongs under docs/.
Show full SKILL.md (364 more words)Show less
Documentation workflow
- Identify the user task and audience before choosing a file.
- Find the canonical existing page and update it rather than creating a competing explanation.
- Keep the README unchanged unless its quick-start path or high-level product story must change.
- If discovery is important, add a short link from the README or relevant docs index instead of duplicating the detail.
- Check nearby pages for stale or contradictory claims.
- Keep commands, names, defaults, and platform statements consistent with the implementation and tests.
- Review the final diff specifically for README growth and duplicated prose.
Writing principles
- Lead with the user outcome, then the command or action needed.
- State what the software does rather than listing what it does not do; reserve "does not" statements for the rare case where behavior genuinely contradicts the most obvious expectation.
- Prefer concrete guidance over internal type, module, or orchestration terminology.
- Explain implementation details only when they help users make a decision or recover from a failure.
- Distinguish supported behavior from recommendations and prospective behavior.
- Avoid promises broader than the tested platform and compatibility contract.
- Keep examples copyable and make destructive or security-sensitive effects explicit.
- Link to one canonical source instead of maintaining subtly different versions of the same guidance.
Release notes and checks
Use .agents/skills/changeset-changelog/SKILL.md when a documentation change is user-visible and belongs in the published release. Do not add a Changeset for internal agent guidance or purely editorial movement that leaves user-facing guidance intact unless the release policy calls for it.
Run the narrowest checks that cover the edited documentation. At minimum:
- inspect links and referenced paths;
- run any focused docs, packaging, or build-content tests associated with the changed files;
- use
git diff --check; - confirm the README remains a concise entry point rather than a second documentation site.
Review checklist
- Is the README still optimized for a new user reaching a successful first run?
- Does each detailed explanation have one canonical home under
docs/? - Did the change avoid copying release notes or implementation design into the README?
- Are links sufficient for readers who need more detail?
- Are paired or related documentation surfaces consistent?
- Are user-visible commands and claims supported by current behavior?
© jmfederico, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file
Files
Just SKILL.md in .agents/skills/documentation-guide of jmfederico/pi-web.
Open the folder on GitHubat commit 15c13a4
Compare with similar skills
Documentation Guide next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.
| Skill | Stars | Used in | Tokens | Auto-check | Licence | Repo updated |
|---|---|---|---|---|---|---|
| Documentation Guide this skilljmfederico/pi-web | 861 | — | ~1.7k | Automated safety check: Pass | MIT | |
| GitHub Readme Generatorwwwzhouhui/skills_collection | 282 | — | ~1.3k | Automated safety check: Notes | None | |
| Generate Dochyochan/react-native-nitro-sound | 961 | — | ~824 | Automated safety check: Pass | MIT | |
| Generate Dochyochan/react-native-nitro-sound | 961 | — | ~157 | Automated safety check: Pass | MIT | |
| DocumentationEliasOulkadi/shokunin | 114 | — | ~2k | Automated safety check: Pass | MIT | |
| Readme WriterFerroxLabs/wayland | 608 | — | ~3.2k | Automated safety check: Notes | Apache-2.0 |
Similar skills
Generate Doc
hyochan/react-native-nitro-sound
Create or update react-native-nitro-sound API documentation, examples, migration notes, FAQ entries, changelog or release notes, and compiled AI context.
Generate Doc
hyochan/react-native-nitro-sound
Create or update react-native-nitro-sound API documentation, examples, migration notes, FAQ entries, changelog or release notes, and compiled AI context when public exports, Nitro specs, native…
Documentation
EliasOulkadi/shokunin
Generate READMEs, API docs, changelogs, and knowledge base articles.
Readme Writer
FerroxLabs/wayland
Expert README and project documentation covering README structure template, badges, installation instructions, quick start guide, configuration reference, contributing guide, license selection…
Opendocs
ioteverythin/OpenDocs
Generates multi-format documentation (Word, PDF, PPTX, Markdown blog post, JIRA ticket, FAQ, changelog, LaTeX, social snippet, architecture diagram) from a GitHub README, npm package, local Markdown…
More from jmfederico/pi-web
Changeset Changelog
jmfederico/pi-web
A skill your agent uses whenever the user asks about changelogs, Changesets, release notes, conventional commits, commit messages for release notes, or making user-visible project changes that…
npm Release Via GitHub Actions
jmfederico/pi-web
A skill your agent uses whenever the user asks for a new npm version, npm release, package release, new release, version bump, publishing to npm, cutting a GitHub release, tagging a release, or…
Testing Guide
jmfederico/pi-web
Repository-specific testing guide. An agent skill from jmfederico/pi-web.
Code Quality Architecture
jmfederico/pi-web
Project code quality and architecture expectations for implementation, refactoring, planning, and code review.
Relay
jmfederico/pi-web
Foundational, tool-agnostic Relay method for carrying long work across a chain of independent agent contexts, one bounded leg at a time.
Relay Runner
jmfederico/pi-web
Opinionated full-lifecycle software-delivery profile for Relay chains in Git repositories.
Related
Categories
Questions about Documentation Guide
What does Documentation Guide do?
Repository documentation placement and writing guidance. An agent skill from jmfederico/pi-web. Documentation Guide is an agent skill from jmfederico/pi-web. Repository documentation placement and writing guidance.
When should I use Documentation Guide?
Documentation Guide fits situations like: planning README.md; anything under docs/; installation instructions; troubleshooting.
How do I install Documentation Guide in Claude Code?
Run `npx skills add jmfederico/pi-web --skill documentation-guide -a claude-code`. Or copy the skill folder (.agents/skills/documentation-guide in jmfederico/pi-web) into .claude/skills/documentation-guide in your project. Claude Code loads it when a task matches its description.
How do I install Documentation Guide in Codex?
Run `npx skills add jmfederico/pi-web --skill documentation-guide -a codex`. Or copy the skill folder (.agents/skills/documentation-guide in jmfederico/pi-web) into .agents/skills/documentation-guide in your project. Codex loads it when a task matches its description.
Can I use Documentation Guide in Cursor, Gemini CLI or GitHub Copilot?
Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add jmfederico/pi-web --skill documentation-guide -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/documentation-guide, .gemini/skills/documentation-guide, .github/skills/documentation-guide and .opencode/skills/documentation-guide in your project.
What does Documentation Guide need to run?
Going by SKILL.md and its folder, Documentation Guide needs the command-line tools its instructions call (git).
Does Documentation Guide access the network?
SKILL.md contains no URLs. Its commands use git, which can reach the network depending on how they are called. This is read from the text; nothing was executed.
Is Documentation Guide safe to install?
Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.
What licence does Documentation Guide use?
Documentation Guide is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.
How many tokens does Documentation Guide use?
About 1.7k tokens (SKILL.md is roughly 6.7k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.
What are the alternatives to Documentation Guide?
Skills that share tags, products or a category with Documentation Guide: GitHub Readme Generator (wwwzhouhui/skills_collection, 282 stars), Generate Doc (hyochan/react-native-nitro-sound, 961 stars), Generate Doc (hyochan/react-native-nitro-sound, 961 stars) and Documentation (EliasOulkadi/shokunin, 114 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.
Who maintains Documentation Guide?
jmfederico (a GitHub user) maintains it in jmfederico/pi-web, which has 861 GitHub stars. The repository holds 7 skills in this directory. The repository was last updated on October 6, 2026.
Source: jmfederico/pi-web on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.