Repository navigation
README update - #234
Open
eddroid wants to merge 6 commits into
Open
README update#234eddroid wants to merge 6 commits into
eddroid wants to merge 6 commits into
Conversation
eddroid
marked this pull request as ready for review
November 3, 2026 23:34
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.
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-descriptionhas written the final description.Do not bump the plugin version and do not edit
CHANGELOG.mdin this PR. Both are handled by the/han-releaseskill when a release is cut. If your branch contains version or changelog changes, revert them before requesting review.Review the changes against project guidance
allowed-toolsaccuracy, context-injection simplicity, template adherence, index placement, link resolution, voice compliance.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").{plugin}/docs/skills/{name}.mdor{plugin}/docs/agents/{name}.md, the plugin'sREADME.mdhas a scent line, and the index indocs/skills/README.mdordocs/agents/README.mdhas a one-sentence scent line.docs/skills/README.md,docs/agents/README.md), anddocs/concepts.mdeach list every current entity.plugin/.claude-plugin/plugin.jsonor.claude-plugin/marketplace.json, confirm both are consistent.Refresh the documentation
Run
/han-update-documentationin 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-descriptionin 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 viagh pr edit.If
/update-pr-descriptionis unavailable, write the description by hand using the same structure: Summary, Key file changes, Test Plan (omit for docs-only branches).