Skip to content

README update - #234

Open
eddroid wants to merge 6 commits into
testdouble:mainfrom
eddroid:eddroid-docs
Open

eddroid wants to merge 6 commits into
testdouble:mainfrom
eddroid:eddroid-docs

Conversation

@eddroid

@eddroid eddroid commented Nov 3, 2026 •

Copy link
Copy Markdown

Docs-only update. Just the README in this PR.

Before requesting review

Work through this checklist before marking the PR ready. Leave it in the PR body while drafting; remove it once /update-pr-description has written the final description.

Do not bump the plugin version and do not edit CHANGELOG.md in this PR. Both are handled by the /han-release skill when a release is cut. If your branch contains version or changelog changes, revert them before requesting review.

Review the changes against project guidance

  • Read CONTRIBUTING.md and confirm the changes follow the rules for the entity being touched (skill, agent, long-form doc, index, template).
  • Walk the self-review checklist in CONTRIBUTING.md: frontmatter validity, allowed-tools accuracy, context-injection simplicity, template adherence, index placement, link resolution, voice compliance.
  • Confirm the writing follows han-communication/references/writing-voice.md. Em-dashes only as a label-gloss separator or an appositive aside. No banned words ("actually", "just", "leverage", "utilize", "showcase", "robust" as vague positive, "It's worth noting", "Importantly").
  • If a new skill or agent was added or renamed, confirm the coverage rule is satisfied: long-form doc exists at {plugin}/docs/skills/{name}.md or {plugin}/docs/agents/{name}.md, the plugin's README.md has a scent line, and the index in docs/skills/README.md or docs/agents/README.md has a one-sentence scent line.
  • If a skill or agent was added, removed, or renamed, confirm the indexes (docs/skills/README.md, docs/agents/README.md), and docs/concepts.md each list every current entity.
  • If the change touches plugin behavior, run the affected skill or agent locally and confirm it still works end-to-end.
  • If the change affects plugin/.claude-plugin/plugin.json or .claude-plugin/marketplace.json, confirm both are consistent.

Refresh the documentation

Run /han-update-documentation in Claude Code from this branch. The skill scopes its pass to the entities this branch touched, syncing the long-form docs, indexes, and cross-references with the changes on disk so the PR ships with accurate documentation.

Generate the PR description

When the checklist above passes, run /update-pr-description in Claude Code from this branch. The skill reads the branch's committed changes, drafts a description that surfaces the central mechanism and key files, runs a reviewer-context check, and pushes the result to this PR via gh pr edit.

If /update-pr-description is unavailable, write the description by hand using the same structure: Summary, Key file changes, Test Plan (omit for docs-only branches).

@eddroid
eddroid marked this pull request as ready for review November 3, 2026 23:34
@eddroid eddroid changed the title Documentation updates README update Nov 4, 2026
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