Skip to content

docs: plain English README and AGENTS.md - #44

Merged
rubas merged 3 commits into
mainfrom
docs/plain-english
Sep 26, 2026
Merged

rubas merged 3 commits into
mainfrom
docs/plain-english

Conversation

@rubas

@rubas rubas commented Sep 26, 2026 •

Copy link
Copy Markdown
Owner

Before

kagi-search returns:

  • text: numbered results plus optional Related: terms
  • json: { "results": [...], "related": [...] }

This sat in an "Output" section far below the kagi-search section it belongs to, and AGENTS.md repeated the whole token lookup order from the README.

Problem

  • Each binary's usage and its output were in two separate sections.
  • AGENTS.md repeated the token lookup and restated the README's goal.
  • Some sentences were long or passive.

After

  • The README reads top down: what it is, install, token, one section per binary with its output, development.
  • AGENTS.md keeps only agent rules: gates, rules, pitfalls.
Fact fixes
  • The first draft also fixed the stale "each binary ships a companion agent skill" line. Drop the kagi agent skill (0.6.0) #42 then dropped the skill; this branch merges it and keeps its text.
  • The zizmor note moved to a Development section of the README, next to nix develop and task check.
  • Checked against the code and kept: installer flags and env vars (install.sh), token order and the 0o077 permission check (src/client.rs), --sort handling (src/client.rs), the CI task list (ci.yml), and the release trigger (release.yml).

Comment thread AGENTS.md Resolved
@rubas
rubas merged commit 69f6c3e into main Sep 26, 2026
3 checks passed
@rubas
rubas deleted the docs/plain-english branch September 26, 2026 21:28
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