docs: rewrite README and expand AGENTS.md - #8
Open
mpicciolli wants to merge 1 commit into
Open
Conversation
README now describes what the plugin actually does — install steps, the two skills, runtime requirements and the read-only invariant — instead of the "Coming soon" placeholder. AGENTS.md documents the current layout (skills live under plugins/pcm/), the validation commands, and the conventions an agent must follow when editing skills or manifests. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
This PR refreshes the repository’s documentation to reflect the current “PCMStack” plugin packaging and to provide clearer user and contributor guidance (install, runtime requirements, skill overview, and repository conventions).
Changes:
- Rewrites
README.mdwith install instructions, skill descriptions, runtime requirements, and a read-only-save safety invariant. - Expands
AGENTS.mdwith updated repository layout, validation workflow, and authoring/style guidelines for skills, scripts, and manifests.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| README.md | New end-user focused overview: install + requirements + per-skill explanation + safety invariant. |
| AGENTS.md | Updated contributor guidance: repo layout, manual validation, conventions, and data-handling rules. |
Suppressed comments (1)
AGENTS.md:185
- This note is now outdated: README.md no longer lists “Coming soon” under Available Skills after this rewrite. Update the bullet so AGENTS.md doesn’t contradict the current README content.
- `README.md` still lists "Coming soon" under Available Skills; it lags the actual contents.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| pcm-startlist/ | ||
| SKILL.md | ||
| AGENTS.md / CLAUDE.md # CLAUDE.md is a one-line `@AGENTS.md` include | ||
| README.md # human-facing; keep it short, guidance lives here |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
.cdbis and why it can be read, install via the marketplace (/plugin marketplace add PCMStack/agent-skills), a section per skill (pcm-database,pcm-startlist), runtime requirements (Node 22+,sqlite3), a flow diagram, and the read-only-save invariant.plugins/pcm/skills/, there are two marketplace manifests and two plugin manifests to keep in sync, and validation is manual. Documents layout, naming conventions, SKILL.md authoring rules, script/JSON style, and the never-commit-a-.cdbrule.Docs only — no skill, script, or manifest behaviour changes.