SkillsAdd

gaelic-ghost/socket · Archived

maintain-project-readme

Maintain README.md as the product-facing member of the canonical four-document repository suite.

First seen Jun 16, 2026

Installation

$ npx skills add gaelic-ghost/socket --skill maintain-project-readme
View on skills.sh ↗ GitHub repository ↗

Stronger alternatives

This repository is archived — consider an actively maintained alternative.

icon-composer-app-icon-workflow Same source · more installs
gaelic-ghost/socket

Design, preview, validate, and integrate Apple app icons with Icon Composer. Use when a task me…

3 installs
maintain-project-accessibility Same source
gaelic-ghost/socket

Maintain canonical ACCESSIBILITY.md files through deterministic audit and bounded apply modes. …

1 installs
expo-inline-native-modules-workflow Same source
gaelic-ghost/socket

Work at the Expo SDK 56+ inline native module boundary with current Expo docs, live project ins…

1 installs
openapi-rpc-workflow Same source
gaelic-ghost/socket

Design, generate, implement, test, and diagnose Swift OpenAPI and RPC-style server contracts us…

1 installs

Similar popular skills

Related neighbors and high-traction skills in the same topics — useful to compare before installing.

azure-rbac Shared topics
microsoft/azure-skills 489K installs
momentic-maintain Similar name
momentic-ai/skills

Diagnose, classify, triage, and repair failing Momentic tests with MCP run tools, the Momentic …

7.1K installs
maintain-greptile-rules Similar name
every-app/open-seo

maintain-greptile-rules — an installable skill for AI agents.

1.9K installs
maintain-verification-skill Similar name
cursor/plugins

Periodic pass that keeps a project's verification skill and feature map honest: parallel source…

1.6K installs
antv-skills-maintainer Similar name
antvis/chart-visualization-skills

Automatically sync documentation and configuration after any skill is added or updated. Trigger…

1.2K installs
maintaining-agent-context Similar name
sentimony/skills

You MUST use this when auditing, improving, restructuring, or maintaining agent instruction fil…

7 installs

Also in this package

Other skills from gaelic-ghost/socket.

npx skills add gaelic-ghost/socket
icon-composer-app-icon-workflow 3 maintain-project-accessibility 1 expo-inline-native-modules-workflow 1 openapi-rpc-workflow 1 uv-pytest-unit-testing 1 build-cli-project 1

Browse all from gaelic-ghost/socket

More details

Agent compatibility

Declared targets from SKILL.md / docs. Unmarked agents are not listed — the skill may still install via the CLI.

Claude Code Not declared
Cursor Not declared
Codex Not declared
GitHub Copilot Not declared
Windsurf Not declared
Gemini CLI Not declared
Cline Not declared
OpenCode Not declared

Repository health

Stars 6
License LICENSE
Default branch main
Open issues 6
Status Archived

Package contents

Files included with this skill beyond the listing page.

  • skill md SKILL.md 2,243 B
  • docs SUMMARY.md 127 B

History

  1. First seen on skills.sh
  2. First recorded snapshot · 1 installs

SKILL.md

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

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