Skip to content

Epic: Docs restructure — 7 tabs → Learn / Build / Operate / Contribute #2266

Description

@GigaHierz

Why

The current seven-tab structure (Home, Build on Celo, Tooling, Contribute to Celo, Infra Partners, Specs, Legacy) mixes audiences, jobs and topics on one axis. Verified at bdf40b37: "Home" is protocol reference with no real homepage; Tooling holds 90 of 292 pages (31%) across ten unrelated groups; Legacy conflates dead L1 content with pages that still apply on L2; 105 duplicate files sit in _deprecated/; 25 tracked pages are unreachable from navigation (including the whole dev-environment-setup group); wallets, fee abstraction and thirdweb are each documented in three or more places; 167 redirects dead-end.

Decisions (agreed — not re-opened in the child issues)

Decision Outcome
Tab shape 7 → 4: Learn / Build / Operate / Contribute
Specs tab Folded into Operate as a "Specification" section; redirects from old specs paths
Legacy tab Removed, not archived. Still-relevant content migrated to Learn (history) or Operate (old L1 node context) before deletion
Tooling tab Dissolved into Build
Build-tab order Quickstart → Agents → Mini Apps → Network info → Guides → Tools → Reference
thirdweb Stays as one tool page at parity with other tools; no code examples, no recommendations
MiniPay One overview that routes to docs.minipay.xyz for the mini-app lifecycle
Code examples Troubleshooting-first: keep edge-case examples (e.g. paying gas in USDC); drop large end-to-end examples derivable from SDK docs
Writing standard AGENTS.md at repo root: headings, structure, writing style, move/redirect checklist
Highest priority now Analytics + an AI assistant (not Mintlify Pro; research Mintlify-compatible and open-source options)
End-user vs tooling Every page states who it is for; end-user project listings also live on celo.org/ecosystem
Orphans Sheet of the orphaned pages only; team marks re-nav/delete; applied in one pass
Startup Pathway link Not re-added (removed with Celo Camp in #2235)

Children, in execution order

# Ticket Owner Depends on Status
#2249 Add Google Analytics (GA4) @viral-sangani done — PR #2267 merged 453efdc2
#2251 AGENTS.md @GigaHierz done — PR #2269 merged a9b0a19c
#2252 Cleanup: _deprecated, dead redirects, orphan CI check @palango done — PR #2279 merged 3604c629
#2254 Remove the Legacy tab @palango #2252 done — PR #2280 merged 762173a0
#2260 Operate tab (+ Specs) @palango #2252 #2254 done — PR #2289 merged a07223d8; specs.celo.org stub re-pointing split to celo-org/specs#199
#2262 Document Self Agent ID @GigaHierz done — PR #2270 merged f2ee83af
#2264 MiniPay: one overview → docs.minipay.xyz @GigaHierz #2251 done — PR #2271 merged a8175ebb
#2240 docs.json duplicate nav entry @palango done — PR #2272 merged bfa4f52d
#2277 Partner contract addresses: link out instead of hardcoding @GigaHierz done — PR #2278 merged ea9ba97f; residual retired-testnet refs split to #2290
#2290 Remaining live Alfajores references (6 pages) open — split out of #2277
#2282 Rewrite the Celo Protocol overview for the L2 @GigaHierz done — PR #2284 merged a4233070
#2250 Research + add an AI assistant @GigaHierz in review — PR #2286, changes requested
#2268 Sepolia USDC token address is the mainnet adapter @GigaHierz done — PR #2273 merged
#2283 Brand-level Organization JSON-LD @GigaHierz in review — PR #2285, rewritten to use Mintlify's native seo.organization after review
#2241 Colliding page titles @GigaHierz #2254 #2255 partly done — PR #2274 merged e38da175 retitled 7 of 9; the thirdweb pair goes with #2255
#2253 Orphaned-pages audit @GigaHierz in review — PR #2293, review findings addressed; orphan check now gates CI
#2255 De-promote thirdweb @GigaHierz #2252 code done — PR #2291 merged. Ops half (usage audit, vendor move) still open
#2265 End-user projects on celo.org/ecosystem @GigaHierz repo-side done — PR #2294 merged; the parity sheet and submissions are ops
#2256 Split wallet docs (end-user vs developer) @GigaHierz #2253 unblocked once #2293 merges
#2139 Release-process doc fixes (not an epic child) @martinvol superseded by PR #2295
#2257 Differentiate fee-abstraction pages @GigaHierz #2253 unblocked once #2293 merges
#2258 Learn tab @GigaHierz #2253 #2256 blocked
#2259 Build tab @GigaHierz #2253 #2255 #2256 #2257 blocked
#2261 Homepage + Contribute + AI resources @GigaHierz #2258 #2259 blocked
#2263 Agent-experience pass @viral-sangani #2259 blocked on #2259 for paths; content draftable now

Tabs at a07223d8 are Home · Build on Celo · Tooling · Contribute to Celo · Operate — Operate has landed; Learn (#2258) and Build (#2259) are the two renames still outstanding.

Overlap rules: #2252 touches no orphaned page (it adds the check); #2253 decides the 22 non-thirdweb orphans; the 3 thirdweb orphans belong to #2255. #2256, #2257, #2264 change content in place; #2258#2260 move paths and do not rewrite content. #2254 owns legacy/, #2258 owns home/, #2259 owns build-on-celo/ + tooling/, #2260 owns infra-partners/ + specs/. #2257 leaves the spec-vs-guide trim to #2227.

Gate for every child PR

npx mintlify broken-links green (CI), the orphan check green once #2253 lands, and every moved or deleted path has a redirect in docs.json.

Prior art (pinned to commits, not branches)

Non-goals

Freshness automation (doc 04 in #2210) — not decided; gets its own issue if and when it is. Re-adding the Startup Pathway link.

Measured at: bdf40b37

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

EpicdocumentationImprovements or additions to documentationenhancementUser story / featurepriority:highMajor feature broken, workaround existssize:LMulti-day: split it if you canstatus: triageNeeds triage

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions