docs(readme): meet open/ presentation standard (repo-standard v0.1.1 gate green)
Gate run before the fix reported 4 ERROR, 1 WARN, 1 SKIP. All addressed: - README-DESC: opening line now byte-identical to the forge description, so description == catalog == README is machine-checkable. - HEADING-LEVEL: `### Install` promoted to `## Install` and moved onto the first screen, with the two-line CLI form (marketplace add + plugin install). The `/plugin` slash form and the enabledPlugins JSON stay as alternatives. - HEADING-MISSING: `## What this plugin does *not* do` renamed `## Non-goals`; `## Changelog` added as a link to CHANGELOG.md. - README-H1 (WARN): `# human-friendly-style` matches the repo name. - LINK-OUTSIDE-REPO (SKIP): the disclosure link `../../README.md#...` was a polyrepo-migration leftover pointing outside the repo at an anchor that never existed. Replaced with the inline text, per catalog's coord notice. Requirements table lifted to the first screen; Compatibility keeps the prose. Style file, manifest and version are untouched — presentation only. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01RsVD6Lq8oMRDCAEjg4HEHi
This commit is contained in:
parent
a4b55fc168
commit
77bcdba0ce
1 changed files with 47 additions and 38 deletions
85
README.md
85
README.md
|
|
@ -1,10 +1,15 @@
|
|||
# Human-Friendly Output Style for Claude Code
|
||||
# human-friendly-style
|
||||
Shared Claude Code output style for the ktg-plugin-marketplace. Plain-language tone — explains what and why, hides paths/JSON/stack traces by default, matches the user's language.
|
||||
|
||||
> A shared output style that gives every plugin in this marketplace a consistent, plain-language tone. Install it once, activate it via `/config`, and Claude Code starts explaining work the way a person would — not the way a console dump does.
|
||||
One Markdown file that changes how Claude *talks about* the work, not how the
|
||||
work is done. For anyone whose Claude Code sessions are read by someone other
|
||||
than a developer at a terminal — a colleague looking over your shoulder, a
|
||||
session you are documenting for someone else, or non-code work where console
|
||||
noise gets in the way.
|
||||
|
||||
> **Solo-maintained, fork-and-own.** This plugin is a starting point, not a vendor product. Issues are welcome as signals; pull requests are not accepted. See [GOVERNANCE.md](GOVERNANCE.md) for the full model and what upstream provides.
|
||||
|
||||
*AI-generated: all code produced by Claude Code through dialog-driven development. [Full disclosure →](../../README.md#ai-generated-code-disclosure)*
|
||||
*AI-generated: all code produced by Claude Code through dialog-driven development. Every change is human-directed, reviewed, and validated before commit.*
|
||||
|
||||
|
||||
|
||||
|
|
@ -13,7 +18,35 @@
|
|||
|
||||
|
||||
|
||||
A Claude Code plugin that ships a single [output style](https://code.claude.com/docs/en/output-styles) used across the [ktg-plugin-marketplace](https://git.fromaitochitta.com/open/ktg-plugin-marketplace). The style modifies Claude Code's system prompt so responses default to prose instead of bullet lists, hide noisy details (long file paths, raw shell commands, JSON blobs, stack traces) until the user asks for them, match the user's language, and stay honest about uncertainty. Claude Code's built-in coding instructions stay intact (`keep-coding-instructions: true`), so testing discipline, careful edits, and verification still apply — only the way Claude *talks about* the work changes.
|
||||
## Install
|
||||
|
||||
Use the `https://` form. The forge UI's clone button hands out an `ssh://` URL,
|
||||
and `marketplace add` answers it with `Invalid git URL`.
|
||||
|
||||
```bash
|
||||
claude plugin marketplace add https://git.fromaitochitta.com/open/ktg-plugin-marketplace.git
|
||||
claude plugin install human-friendly-style@ktg-plugin-marketplace
|
||||
```
|
||||
|
||||
Inside a running session, `/plugin install human-friendly-style@ktg-plugin-marketplace` does the same thing. Or enable it directly in `~/.claude/settings.json`:
|
||||
|
||||
```json
|
||||
{
|
||||
"enabledPlugins": {
|
||||
"human-friendly-style@ktg-plugin-marketplace": true
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Installing does not activate it — see [Activate](#activate).
|
||||
|
||||
## Requirements
|
||||
|
||||
| Requirement | Version |
|
||||
|-------------|---------|
|
||||
| Claude Code | recent versions with output style support |
|
||||
| Platform | macOS, Linux, Windows |
|
||||
| Network | None — output styles are local Markdown files |
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -34,6 +67,8 @@ This plugin solves that with one short Markdown file and the official Claude Cod
|
|||
|
||||
## What it does
|
||||
|
||||
This plugin ships a single [output style](https://code.claude.com/docs/en/output-styles) used across the [ktg-plugin-marketplace](https://git.fromaitochitta.com/open/ktg-plugin-marketplace). The style modifies Claude Code's system prompt so responses default to prose instead of bullet lists, hide noisy details (long file paths, raw shell commands, JSON blobs, stack traces) until the user asks for them, match the user's language, and stay honest about uncertainty. Claude Code's built-in coding instructions stay intact (`keep-coding-instructions: true`), so testing discipline, careful edits, and verification still apply — only the way Claude *talks about* the work changes.
|
||||
|
||||
The style file at `output-styles/human-friendly.md` declares nine directives that ride on top of Claude Code's normal system prompt:
|
||||
|
||||
| # | Directive | What it changes |
|
||||
|
|
@ -105,33 +140,7 @@ One thing the style does *not* hide, even unprompted: **irreversible actions**.
|
|||
|
||||
---
|
||||
|
||||
## Quick start
|
||||
|
||||
### Install
|
||||
|
||||
Add the marketplace once, then install the plugin:
|
||||
|
||||
```bash
|
||||
claude plugin marketplace add https://git.fromaitochitta.com/open/ktg-plugin-marketplace.git
|
||||
```
|
||||
|
||||
In Claude Code:
|
||||
|
||||
```
|
||||
/plugin install human-friendly-style@ktg-plugin-marketplace
|
||||
```
|
||||
|
||||
Or enable directly in `~/.claude/settings.json`:
|
||||
|
||||
```json
|
||||
{
|
||||
"enabledPlugins": {
|
||||
"human-friendly-style@ktg-plugin-marketplace": true
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Activate
|
||||
## Activate
|
||||
|
||||
```
|
||||
/config
|
||||
|
|
@ -177,7 +186,7 @@ Removing the style is as simple: `/config` → **Output style** → **(default)*
|
|||
|
||||
---
|
||||
|
||||
## What this plugin does *not* do
|
||||
## Non-goals
|
||||
|
||||
By design, this plugin contains no commands, no agents, no hooks, no skills, no MCP servers. It ships exactly one file plus a manifest. That is the whole point — a shared conversational style should be a small, predictable thing that adds zero runtime overhead and zero surface area to audit.
|
||||
|
||||
|
|
@ -202,12 +211,6 @@ The style is **optional**. Every plugin in the marketplace works without it. Thi
|
|||
|
||||
## Compatibility
|
||||
|
||||
| Requirement | Version |
|
||||
|-------------|---------|
|
||||
| Claude Code | recent versions with output style support |
|
||||
| Platform | macOS, Linux, Windows |
|
||||
| Network | None — output styles are local Markdown files |
|
||||
|
||||
Output styles are a first-class feature in Claude Code's plugin system. Older Claude Code releases without `/config` → Output style support will install the plugin without errors but will not apply the style. See [Claude Code Output Styles documentation](https://code.claude.com/docs/en/output-styles) for the canonical reference.
|
||||
|
||||
---
|
||||
|
|
@ -220,6 +223,12 @@ Output styles are a first-class feature in Claude Code's plugin system. Older Cl
|
|||
|
||||
---
|
||||
|
||||
## Changelog
|
||||
|
||||
See [CHANGELOG.md](CHANGELOG.md).
|
||||
|
||||
---
|
||||
|
||||
## License
|
||||
|
||||
[MIT](LICENSE). Fork it, modify it, ship your own version under your own name.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue