Skip to content

Add "Inki" Claude Code plugin: research, write, review, submit Strapi Docs update#3200

Merged
pwizla merged 82 commits into
mainfrom
repo/inki-plugin-init
Jun 4, 2026
Merged

Add "Inki" Claude Code plugin: research, write, review, submit Strapi Docs update#3200
pwizla merged 82 commits into
mainfrom
repo/inki-plugin-init

Conversation

@pwizla

@pwizla pwizla commented May 22, 2026

Copy link
Copy Markdown
Collaborator

This PR introduces the Inki Claude Code plugin at claude-plugins/inki/, exposing 21 skills across four families (Research, Write, Review, Submit) to help maintain the Strapi documentation.

  • Migrates agents/prompts/, agents/templates/, agents/authoring/ into claude-plugins/inki/references/ so the plugin is self-contained. agents/ is kept as a pointer README so users who do not install the plugin, but cloned the repo, will still have their AI agents understand where files live.

  • Adds a self-hosted marketplace manifest at .claude-plugin/marketplace.json so contributors can install with /plugin marketplace add strapi/documentation then /plugin install inki@strapi-documentation

  • Keeps git-rules.md and 12-rules-of-technical-writing.md at the repo root as the canonical versions (still readable for contributors who don't use Claude Code). A GitHub Action auto-syncs them into the plugin's references on every PR and blocks edits made only to the plugin copy, to keep root and plugin in sync.

  • Updates AGENTS.md, .cursor/rules/, and .github/prompts/ to reference the new claude-plugins/inki/references/ paths.

This PR opens the plugin as a draft for staged rollout.

pwizla added 30 commits May 22, 2026 16:26
@pwizla

pwizla commented Jun 2, 2026

Copy link
Copy Markdown
Collaborator Author

TODO before merging this PR

This PR migrates agents/ content into claude-plugins/inki/references/. As long as this PR is not merged, any change made to agents/** on other branches will be silently lost when this PR finally merges (because agents/ is removed here).

Required sync step before marking ready

  1. Run this query to find PRs that touched agents/** between this PR's creation and its merge:
    gh pr list --repo strapi/documentation --state all --limit 200 \
      --json number,title,mergedAt,author,files \
      --jq '[.[] | select(.files[].path | startswith("agents/")) | {number, title, mergedAt, author: .author.login}]'
  2. For each PR (open or recently merged) that touched agents/**, manually mirror the diff into claude-plugins/inki/references/:
    • agents/prompts/<file>.mdclaude-plugins/inki/references/prompts/<file>.md
    • agents/templates/<file>.mdclaude-plugins/inki/references/templates/<file>.md
    • agents/authoring/<file>.mdclaude-plugins/inki/references/authoring/<file>.md
  3. Commit the mirrored changes to this branch with a message like Mirror PR #<num> changes to inki/references/ before merge.
  4. Verify with diff that the inki/references/ versions match what's expected.

Already mirrored on this branch

After this PR merges

The agents/ folder is replaced by a single pointer README. From then on, all changes go directly to claude-plugins/inki/references/. This mirror dance disappears.

* Accept docs.strapi.io URLs, filenames, and pasted content as review targets

* Document flexible review targets in README and CHANGELOG

* Resolve docs.strapi.io review targets against origin/main

A docs.strapi.io URL points at the published page, so the review now reads the source from origin/main (via git fetch + git show, never a destructive pull) and warns when local uncommitted changes to that file are excluded.

* Document origin/main URL resolution in inki CHANGELOG

* Review docs.strapi.io URLs in an origin/main worktree

Resolve a docs.strapi.io URL into a temporary detached worktree on origin/main (new main-worktree.sh helper) instead of a loose /tmp file, so the source sits at its real path under docusaurus/docs/ and coherence-check and code-verify keep resolving relative links and sibling pages.
@pwizla pwizla marked this pull request as ready for review June 4, 2026 12:55
@pwizla pwizla changed the title Add "Inki" Claude Code plugin: discover, write, review, submit your docs Add "Inki" Claude Code plugin: research, write, review, submit Strapi Docs update Jun 4, 2026
@pwizla pwizla merged commit 837558c into main Jun 4, 2026
2 of 5 checks passed
@pwizla pwizla deleted the repo/inki-plugin-init branch June 4, 2026 12:55
@pwizla pwizla removed the flag: don't merge This PR should not be merged at the moment label Jun 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

internal PRs created by the Strapi core team pr: new content PRs for new product features or new documentation sections source: repo PRs/issues not targeting a specific documentation but rather affecting the whole repo

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant