Skip to content

docs(readme): open with why it exists; move Under the hood down - #24

Merged
himanshu096 merged 1 commit into
mainfrom
docs/readme-order
Sep 28, 2026
Merged

himanshu096 merged 1 commit into
mainfrom
docs/readme-order

Conversation

@lucazagaia

Copy link
Copy Markdown
Collaborator

What this changes, and why

The README now opens with why Skill++ exists: Why this exists is the first
section, ahead of See it. Under the hood moves down, after Your first
skill
and next to The numbers, so Quick Start and a first skill come
before the internals.

New order: Why this exists · See it · How it works · What it costs · Quick
Start · Your first skill · Under the hood · The numbers · When to use · (rest
unchanged).

The nav bar follows the new order. Only sections moved: every line is kept,
and the "② above", "③ above" and "video above" references still point up.

How it was checked

  • python3 -m unittest discover -s tests passes
  • python3 scripts/leak_guard.py passes
  • a behaviour change has a test (n/a: README only)
  • a detection or matching change has a measurement on recorded sessions,
    written into docs/research/benchmarks.md (n/a)
  • the README or docs/ say what changed, if a user would notice

Why this exists is now the first section, ahead of See it. Under the hood
moves down, after Your first skill and next to The numbers, so Quick Start
and a first skill come before the internals. The nav bar follows the new
order. Only sections moved: every line is kept, and the "② above",
"③ above" and "video above" references still point up.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

@himanshu096 himanshu096 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@himanshu096
himanshu096 merged commit e4b5752 into main Sep 28, 2026
11 checks passed
@lucazagaia
lucazagaia deleted the docs/readme-order branch September 28, 2026 12:10
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.

2 participants