Commit acdc8b7
authored
docs(README): link to the docs site next to the badges (#36)
* docs: marketing-grade home + Quickstart polish
Home (introduction.mdx):
- New hero: 'Build LLM agents in Rust without the duct tape.' Three lines
of pitch with concrete numbers (six providers, six vector stores, one
umbrella crate) instead of a 47-word run-on.
- Shields.io badges row across the top: GitHub stars, crates.io version,
docs.rs, Rust 1.75+, MIT, CI status. Same set the README ships, just
surfaced where first-time visitors land.
- New 'Real apps you can ship today' strip with three Pattern cards
(research assistant, code Q&A over a repo, streaming UI). Patterns
was buried in 'Where to next'; now it's the second thing visitors
scroll to.
- 'What you can build' cards re-tightened. Stateful graphs in
particular went from a 7-feature run-on to a value-led one-liner.
- 'How Cognis is organized' (workspace map) removed from the home —
it's internal architecture and lives in /reference/api/cognis.
- New 'What's not here yet' section, honest about LangSmith / OTel
gaps, missing managed runtime, the smaller provider matrix. Builds
trust faster than 'we have everything.'
- New 'Like what you see? Star the repo.' card at the bottom — explicit
CTA where visitors finish reading.
Quickstart:
- Description: 'Build a tool-calling agent in five minutes' →
'From zero to a running agent in five minutes.' (also updates the
Quickstart card on the home.)
- New 'What you just built' section between the run command and
'How it works'. Closes the loop — visitor finishes the tutorial
feeling they understood it, not just typed it.
* docs(README): link to the docs site next to the badges
- New Docs badge in the badge row (top of README), styled with the
project orange so it stands out among the standard shields.
- Quick-nav line directly under the badges with five jump links
(Website, Quickstart, Patterns, API reference, Contribute) so a
GitHub visitor sees where to go without scrolling.
- Replaced the bare 'API docs: docs.rs/cognis, per-crate.' line near
the bottom with a two-bullet block that surfaces both the docs site
and rustdoc.1 parent 1cc7812 commit acdc8b7
1 file changed
Lines changed: 6 additions & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
4 | 4 | | |
5 | 5 | | |
6 | 6 | | |
| 7 | + | |
7 | 8 | | |
8 | 9 | | |
9 | 10 | | |
10 | 11 | | |
11 | 12 | | |
12 | 13 | | |
| 14 | + | |
| 15 | + | |
13 | 16 | | |
14 | 17 | | |
15 | 18 | | |
| |||
307 | 310 | | |
308 | 311 | | |
309 | 312 | | |
310 | | - | |
| 313 | + | |
| 314 | + | |
| 315 | + | |
311 | 316 | | |
312 | 317 | | |
313 | 318 | | |
| |||
0 commit comments