celo-org / celo-org/docs

Disambiguate colliding page titles (Overview x3, Bridging, Escrow, Encrypted Payment Comments)

Open
#2,241 1 comment 0 reactions 0 assignees View on GitHub
chore documentation follow-up low priority:low size:S
Dominant language
MDX
Stars
90
Forks
382
Avg merge
3d 9h
Merged PRs (30d)
35

Description

Follow-up from #2237.

Four titles collide across nine pages. Titles are faithful to frontmatter (zero mismatches across all entries) — the pages themselves are just named ambiguously.

This matters most for `llms.txt`, where an assistant picking a page to fetch sees only the title:

- **`Overview`** ×3
- `infra-partners/notices/overview`
- `legacy/overview`
- `legacy/validator/key-management/summary`
- **`Bridging`** ×2 — `home/bridged-tokens/bridges`, `tooling/bridges/bridges`
- **`Escrow`** ×2 — `home/protocol/escrow`, `legacy/protocol/transaction/escrow`
- **`Encrypted Payment Comments`** ×2 — `home/protocol/transactions/tx-comment-encryption`, `legacy/protocol/transaction/tx-comment-encryption`

## Fix

Disambiguate `title:` in frontmatter. `sidebarTitle:` can keep the short form, so the sidebar is unchanged — e.g. `title: "Network Notices Overview"` with `sidebarTitle: "Overview"`.

The `home/` vs `legacy/` pairs mostly need the legacy one marked as such, since the collision is L1-vs-current rather than two genuinely different topics.

Note: largely mitigated for free if #2239 lands, since descriptions disambiguate too. Worth doing anyway for the sidebar and search.

Contributor guide

Open the contributing guide

Research direction

Open the nine listed pages and inspect their title and sidebarTitle frontmatter, starting with the three Overview paths and the home/legacy pairs. Keep short sidebar labels where specified, but make each full title identify its topic or legacy status. Done means the four collision groups no longer share ambiguous full titles while the sidebar remains unchanged.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Clearly specified
Newbie friendliness
78/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.