Skip to content

docs(readme): rewrite as image-free usage guide and drop SVG diagrams - #14

Merged
emmadal merged 1 commit into
mainfrom
docs/readme-clean-no-images
Nov 10, 2026
Merged

emmadal merged 1 commit into
mainfrom
docs/readme-clean-no-images

Conversation

@emmadal

@emmadal emmadal commented Nov 10, 2026

Copy link
Copy Markdown
Owner

Summary

The README relied on three SVG diagrams and hid the practical details. This rewrite is text-only and explains how to actually use the repo.

Changes

  • README.md: no images; install (plugin + install_skills per tool), how to invoke skills and agents per tool, the workflow skill-by-skill, session continuity, personal skills, the 11 agents, all 39 skills grouped, why it is cheap and precise (routing + behavioral numbers matching docs/benchmarks.md), develop/contribute steps, limits (what was verified by running, per tool), project structure and principles
  • Counts and version current: 39 skills, 11 agents, plugin 0.2.0
  • assets/ (workflow, architecture, install SVGs) deleted — nothing references them anymore

Testing

  • validate_skills OK · sync_agents --check OK · routing eval 119 prompts 97.5% rank-1, 39/39 negatives · pytest 78 passed
  • grep for assets/|<img|!\[ in the repo: no matches

- Replace the three SVG diagrams with text: a permissions table, the
  workflow skill-by-skill table and the per-tool read paths table
- Explain install (plugin and install_skills), invocation per tool,
  session continuity, personal skills and contributing step by step
- Update counts to 39 skills / 11 agents and plugin version 0.2.0
- Limits section states exactly what was verified by running per tool
- Delete assets/ (workflow, architecture, install SVGs) now that nothing
  references them
@qodo-code-review

Copy link
Copy Markdown

ⓘ Qodo reviews are paused because the subscription is no longer active. Ask your workspace admin to reactivate the subscription to resume reviews. Manage billing

@emmadal
emmadal merged commit 23b202b into main Nov 10, 2026
3 checks passed
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