docs(guides): reorganize User Guides nav, fill stubs, trim bloated guides#1865
docs(guides): reorganize User Guides nav, fill stubs, trim bloated guides#1865kovtcharov wants to merge 1 commit into
Conversation
Reorganize the flat User Guides nav into seven logical sub-groups ordered easiest→advanced (Setup & Hardware → Core Agents → Developer Tools → Connected Agents → Specialized Agents → Build & Extend → MCP Integration), so readers can find the right agent instead of scanning a 22-item list. Fill the thin stubs to the quality bar of chat/code: telegram-adapter goes from a 17-line placeholder to a full guide (install extra, BotFather token, start/stop/status, allow-list, background daemon, per-user sessions); browse and analyze gain prerequisites and next-steps cross-links. Every command and flag verified against src/gaia/cli.py and the agent source. Trim the three most bloated guides — jira 760→388, memory 781→523, emr 695→464 — by cutting duplicate examples, padded best-practices, and copy-pasted test harnesses while preserving all accurate, load-bearing content. Fixed several stale commands/paths found against source along the way. Add missing icon frontmatter (analyze, browse, email, npu, telegram) and missing description frontmatter (blender, docker, jira, routing, telegram); every guide now carries a consistent title/description/icon triple. Rebuild the guides landing page to mirror the new groups and include all agents. Internal link check passes (Broken: 0).
|
Verdict: Approve with suggestions — safe to merge. This PR reorganizes the User Guides sidebar into seven sub-groups, fills the Telegram/Browse/Analyst stub guides, and trims the bloated Jira/memory/EMR guides — all on top of the in-flight #1102 routing-migration baseline, which moves The one thing worth fixing before merge is small: the new Document Q&A packaging manifest under-declares its filesystem permissions — it registers file write/edit tools but its manifest only lists read access (details below). Non-blocking. 🔍 Technical details🟢 MinorDocQA manifest under-declares write permission (
(If the read-only declaration is intentional — i.e. DocQA is meant to be retrieval-only — the cleaner fix is to drop Strengths
|
b3163f8 to
3f7d1bd
Compare
Why this matters
The User Guides were a flat, 22-item sidebar list with three near-empty stub pages and three 700+ line guides padded with duplicate examples and copy-pasted test harnesses — a new user couldn't tell where to start, and the Telegram, Browser, and Analyst agents had effectively no documentation. This restructures the guides into seven logical sub-groups ordered easiest→advanced, brings every stub up to the chat/code quality bar, and trims the bloated guides down to their load-bearing content. Every command and flag was re-verified against
src/gaia/cli.pyand the agent source, so the docs now match the shipping CLI.Threads
telegram-adapterrewritten from a 17-line placeholder into a full guide (install extra, BotFather token,start/stop/status, allow-list, background daemon, per-user sessions);browseandanalyzegain prerequisites + next-steps cross-links.jira760→388,memory781→523,emr695→464, cutting duplicate examples and padded sections while preserving accurate content. Several stale commands/paths fixed against source.icon(analyze, browse, email, npu, telegram) anddescription(blender, docker, jira, routing, telegram); every guide now has a consistent title/description/icon triple. Landing page rebuilt to mirror the new groups.Test plan
python3 util/check_doc_links.py --internal-only→ Broken: 0 (985 links checked)docs/guides/*.mdxpage still referenced indocs.json(no orphans)docs.jsonis valid JSON