How do I install the Maintain Project Readme skill?

Run npx skillmds@latest add gaelic-ghost/maintain-project-readme in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.

Is Maintain Project Readme safe to use?

This skill has not completed SkillMD's automated safety review yet. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.

Which AI agents work with Maintain Project Readme?

This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.

Is Maintain Project Readme free to use?

Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.

Who published Maintain Project Readme?

gaelic-ghost (@gaelic-ghost) published this skill. Their other Agent Skills are listed on their SkillMD profile.

Maintain Project Readme by gaelic-ghost

Name: Maintain Project Readme
Author: gaelic-ghost

File contents

Maintain Project README

Purpose

Keep README.md product-focused while the repository's README, CONTRIBUTING, AGENTS, and ROADMAP documents are checked or applied as one deterministic unit.

Commands

There are exactly two documentation commands:

just docs-check
just docs-apply

Both commands always process all four canonical documents in this order: README, CONTRIBUTING, AGENTS, ROADMAP. Never expose or recommend a per-file documentation command or direct .fsx invocation.

Managed Contract

assets/document.contract.json is the fixed structural contract.
assets/README.template.md is the bootstrap and missing-content asset.
The contract is versioned with the skill and is not project-customizable.
Existing prose and allowed additional sections are preserved; canonical headings, aliases, ordering, and fix policy cannot be overridden.

README Ownership

README owns product identity, current status, quick start, usage, repository shape, release-note discovery, and license discovery. Contributor workflow, agent policy, release procedure, and roadmap tickets belong to their canonical owners and should be linked rather than duplicated.

Preserve existing user-authored Overview prose. Missing Overview content uses the exact managed TBD scaffold and is reported without inventing claims.

Deterministic Workflow

Run just docs-check for a no-write four-document audit.
Run just docs-apply when structural normalization is requested.
The coordinator plans all four outputs before writing any file.
Apply uses atomic replacements and rolls back completed writes on failure.
A second apply must be byte-identical and produce no change.

Guardrails

Never edit or check README in isolation from the full document suite.
Never invent product claims, commands, guarantees, or support promises.
Never add project-local schema or fix-policy customization.
Never commit, push, or open a pull request as part of documentation upkeep.

References

assets/document.contract.json
assets/README.template.md

---name: maintain-project-readmedescription: Maintain README.md as the product-facing member of the canonical four-document repository suite.---# Maintain Project README## PurposeKeep `README.md` product-focused while the repository's README, CONTRIBUTING,AGENTS, and ROADMAP documents are checked or applied as one deterministic unit.## CommandsThere are exactly two documentation commands:```textjust docs-checkjust docs-apply```Both commands always process all four canonical documents in this order:README, CONTRIBUTING, AGENTS, ROADMAP. Never expose or recommend a per-filedocumentation command or direct `.fsx` invocation.## Managed Contract- `assets/document.contract.json` is the fixed structural contract.- `assets/README.template.md` is the bootstrap and missing-content asset.- The contract is versioned with the skill and is not project-customizable.- Existing prose and allowed additional sections are preserved; canonical headings, aliases, ordering, and fix policy cannot be overridden.## README OwnershipREADME owns product identity, current status, quick start, usage, repositoryshape, release-note discovery, and license discovery. Contributor workflow,agent policy, release procedure, and roadmap tickets belong to their canonicalowners and should be linked rather than duplicated.Preserve existing user-authored Overview prose. Missing Overview content usesthe exact managed `TBD` scaffold and is reported without inventing claims.## Deterministic Workflow1. Run `just docs-check` for a no-write four-document audit.2. Run `just docs-apply` when structural normalization is requested.3. The coordinator plans all four outputs before writing any file.4. Apply uses atomic replacements and rolls back completed writes on failure.5. A second apply must be byte-identical and produce no change.## Guardrails- Never edit or check README in isolation from the full document suite.- Never invent product claims, commands, guarantees, or support promises.- Never add project-local schema or fix-policy customization.- Never commit, push, or open a pull request as part of documentation upkeep.## References- `assets/document.contract.json`- `assets/README.template.md`

Frequently asked questions

Maintain Project Readme