Skip to content

docs: make Cursor plugin repository easier to scan - #20

Merged
AlexMikhalev merged 2 commits into
mainfrom
codex/prettify-cursor-plugin-readme
Nov 1, 2026
Merged

AlexMikhalev merged 2 commits into
mainfrom
codex/prettify-cursor-plugin-readme

Conversation

@AlexMikhalev

@AlexMikhalev AlexMikhalev commented Nov 1, 2026 •

Copy link
Copy Markdown
Contributor

Summary

  • Add the existing logo and V-model artwork to the landing README, with a short quick start and scannable host table.
  • Lead the distribution guide with the signed v0.2.7 release and its macOS ARM64 native review.
  • State that production sign-off is pending, older v0.2.4 host examples cover three skills, and marketplace admission is separately verified.

Verification

  • Full test suite: 150 passed, 15 skipped.
  • Distribution generator --check, git diff --check, and local reviewed-native-evidence check passed.
  • GitHub Actions Validate public marketplace pack passed on head ca6e489.
  • Second-round structural review is posted in this PR: 5/5, no remaining findings.

Scope

Documentation only. The bundled integrations/cursor/README.md remains byte-for-byte unchanged so the source-bound v0.2.7 native evidence stays valid. No plugin code, package contents, or release artifacts changed.

Repository metadata to apply after merge

  • Description: “Four open-source skills for local search, editor synonyms, explicit learning, and authored memory in Cursor and coding agents.”
  • Topics: cursor-plugin, agent-skills, code-search, knowledge-graph, local-first, terraphim.
  • Leave homepage unset until a plugin-specific landing page exists.

Copy link
Copy Markdown
Contributor Author

Summary

This PR makes the Terraphim Skills Introduction repository easier to scan and brings its release guidance up to v0.2.7.

  • README: Adds the existing logo and V-model illustration, a short quick start, and a host availability table.
  • Distribution guide: Links the current signed release and its macOS ARM64 native receipt and independent review, while labeling older three-skill host procedures as historical.
  • Cursor setup: States the exact v0.2.7 qualification scope and preserves the separate marketplace and automatic capture boundaries.

Two P2 findings from the pre-PR pass are resolved: all three status summaries now disclose productionSignoff: PENDING_USER_SIGNOFF, and the README explains that v0.2.4 host examples do not qualify the current four-skill release on other hosts. No findings remain. The v0.2.7 release assets and still-open Grok Build submission were independently checked. The full suite passed 150 tests with 15 skipped; focused documentation checks passed 65 tests; the distribution generator --check and git diff --check passed.

Confidence Score: 5/5

  • Safe to merge with minimal risk.
  • No P0, P1, or P2 findings remain. The documentation preserves the distinction between source release, native qualification, production sign-off, and curated marketplace admission.
  • No files require special attention.

Important Files Changed

Filename Overview
README.md Adds the visual introduction, quick start, and clearer host routes. It states the production sign-off and host qualification limits.
docs/distribution.md Updates the lead release to v0.2.7 and labels older host examples as historical. Release and qualification links resolve to reviewed source.
integrations/cursor/README.md Updates the native qualification summary without implying marketplace admission or automatic failure capture.

Diagram

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[Reader opens README] --> B[Choose installation route]
    B --> C[Signed v0.2.7 source release: four skills]
    C --> D[Cursor local copy]
    C --> E[Other direct or custom host routes]
    D --> F[macOS ARM64 native review: PASS]
    F --> G[Production sign-off: pending]
    E --> H[Historical v0.2.4 three-skill examples]
    H --> I[Current host qualification: separate evidence required]
    B --> J[Curated marketplace]
    J --> K[Maintainer admission: separately verified]
    classDef clarified fill:#d4edda,stroke:#28a745
    class B,C,G,H,I,K clarified
Loading

Inline Findings

No P0, P1, or P2 findings remain.

Last reviewed commit: 51416eb | Reviews (1)

Copy link
Copy Markdown
Contributor Author

Summary

This PR improves the repository’s public README and updates its distribution guide to describe the signed v0.2.7 release with precise qualification boundaries.

The previous review’s two P2 clarity findings remain resolved: the docs disclose pending production sign-off and distinguish historical v0.2.4 three-skill host examples from the current four-skill release. The first PR head also changed integrations/cursor/README.md, which belongs to the qualified release payload. CI correctly rejected that change. Commit ca6e489 restores the file byte-for-byte; it is no longer in the PR diff.

The PR now changes only README.md and docs/distribution.md. The hosted Validate public marketplace pack workflow passed. Locally, focused distribution tests passed (19/19), as did distribution generation and git diff --check. No findings remain.

Confidence Score: 5/5

  • Safe to merge with minimal risk.
  • No P0, P1, or P2 findings remain. The qualified package bytes are unchanged, and the release, production sign-off, and marketplace status claims match their linked evidence.
  • No files require special attention.

Important Files Changed

Filename Overview
README.md Adds the existing logo and V-model artwork, a quick start, and a scannable host table. It states the pending production sign-off and limits of host qualification.
docs/distribution.md Leads with v0.2.7, links the exact native receipt and independent review, and labels v0.2.4 host procedures as historical.

Diagram

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[README and distribution guide] --> B[Signed v0.2.7 release]
    B --> C{PR changes qualified package bytes?}
    C -->|No: current head| D[Existing native evidence remains bound]
    C -->|Yes: prior head| E[CI rejects change; requalification required]
    D --> F[Marketplace-pack CI passes]
    D --> G[Production sign-off remains pending]
    F --> H[Docs can be merged]
    H --> I[Curated marketplace admission remains separate]
    classDef resolved fill:#d4edda,stroke:#28a745
    class D,F,H resolved
Loading

Inline Findings

No P0, P1, or P2 findings remain.

Last reviewed commit: ca6e489 | Reviews (2)

@AlexMikhalev
AlexMikhalev merged commit bf9db89 into main Nov 1, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant