docs(start-here): newcomer ecosystem guide #9
Labels
No labels
agent:implement
agent:research
docs
feature
ready
research
No milestone
No project
No assignees
1 participant
Notifications
Due date
No due date set.
Dependencies
No dependencies set.
Reference
code/cl8y-docs#9
Loading…
Add table
Add a link
Reference in a new issue
No description provided.
Delete branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Summary
https://docs.cl8y.com/is still a v0 stub that explains the documentation host (methodology / markets / contracts / guides). Newcomers who are sent that URL from marketing posts, videos, or community replies do not get a plain-English map of the live products: CL8Y, the Bridge, the DEX, CMM, and the major first-party tokens/assets.Ship one Start Here ecosystem guide on the existing home path so the origin itself is the share URL. Bundle (do not split):
v0 platform work (#3) already shipped crawl files, unique titles, and stub routes. Full manuscripts were explicitly out of scope there. This issue is the first approved public explainer.
Parent / siblings (do not re-implement):
code/cl8y-docs#3 — v0 host + stubs; out of scope: “Full methodology/guide manuscripts (stubs only).”docs/ARCHITECTURE.md§4 / §12 — closed route allowlist; no unverified stats; no unpublished marketingcontent/guides/.code/CL8Y-web#1 — marketing homepage reposition (Bridge + DEX + CL8Y utility token). Different deployable; do not copy that SPA or restyle this host to match it.code/ustr-cmm— first-party CMM product tree (collateralized CW20 system + treasury). Source of names, not a place to paste unpublished manuscripts.Current codebase
Home is host chrome, not an ecosystem guide:
src/pages/HomePage.tsx— “This host is the crawlable knowledge layer…” plus four hub links. No Bridge, no CMM, no token purposes, no diagram.src/pages/GuidesPage.tsx— only/guides/open-the-dex.src/pages/ContractsPage.tsx+src/data/contracts.ts— Terra Classic CL8Y CW20, CL8Y/cLUNC pair, BSC CL8Y, MegaETH CL8Y, nativeuluna.src/components/Layout.tsx— nav +dexHref“Open the DEX” only. No Bridge CTA.src/seo.ts— home titleCL8Y docs; description is host-oriented.src/content/invariants.ts—BANNED_CURRENT_COPYincludesUST1,USTR, GameFi lore, “Buy CL8Y”, “the future of DeFi”.FORBIDDEN_CLAIM_PATTERNSbans TVL / “best DEX” / CoinGecko / CMC / DeFiLlama.src/lib/dexHref.ts— closed campaigns; execute ids only;utm_campaign=homeon/.e2e/crawl.spec.ts— unique titles/canonicals for the seven v0 paths.Architecture §4 purpose of
/is still “what this host is.” This issue redefines/as Start Here (ecosystem map) while keeping one honest sentence that this host is first-party static docs, plus the four hub links. Do not add/guides/start-here(that would expand the closed allowlist, sitemap, campaigns, and nginx prerender set). A future UST1-only route remains a separate approved issue (ARCHITECTURE §4).Duplicates / already implemented
src/data/contracts.ts; do not invent extrascontent/guides/If
/already reads as a complete Start Here (plain-English products + diagram + token purposes) and AC1–AC10 pass on prerendered HTML, close as implemented — do not duplicate.Why the new implementation is needed
The public docs origin is the URL operators want to hand newcomers. Today it only says the site is a static knowledge layer. Without this page:
/contractswith no “what is this for” prose.This is documentation copy + one static diagram on an existing route. No new host, no wallet UI, no Coolify SKU pick.
Constraints / guardrails
Route. Implement on
/only. Do not add paths. Sitemap loc count stays the seven v0 URLs unless architecture is amended in this same PR (not desired).Reader. Zero prior knowledge. Short sentences. No whitepaper dump. No trading tutorial (that stays
/guides/open-the-dex).Products to explain (required).
code/CL8Y-web#1 narrative).https://bridge.cl8y.com. One or two sentences: move supported assets between supported chains; not a DEX.https://dex.cl8y.com. Swap / pools live there; this host does not embed quotes.code/ustr-cmm: collateralized CW20 stablecoin system + governance-controlled treasury that also receives DEX LP on some pairs). Plain English: it issues/manages collateralized tokens and holds treasury/LP; it is not the DEX UI and not the Bridge.Major tokens/assets. Purpose lines only for first-party strings already on
/contractsplus the CMM set that must be named to explain CMM. Suggested table (wordsmith OK; do not add unverified addresses):src/data/contracts.ts, CL8Y-web #1uluna)code/ustr-cmmREADME — names only, no CR/supply/APYcontracts.ts/ token directoryDo not list GameFi / PROTOCASS / Karnyx / TigerHunt. Do not lead with memecoin / “expensive token” / Autoscarcity.
Banned-copy exception (bounded). INVARIANTS 12 /
BANNED_CURRENT_COPYcurrently forbidUST1andUSTRon current-product surfaces so the v0 stubs cannot revive the old marketing story. Start Here must name those tokens to explain CMM. Allow them only as factual names in the CMM / assets section of/(and tests for that page). Keep the ban on GameFi lore, “Buy CL8Y” as a CTA, “the future of DeFi”, TVL, “best DEX”, CoinGecko/CMC/DeFiLlama. Do not add/ust1or/ustrroutes.Claims. No fee, TVL, volume, ranking, collateral ratio, circulating supply, or APY figures unless already printed as first-party constants in this repo (they are not). “See DEX / public indexer” is the markets pattern; reuse it. No CoinGecko/CMC as proof.
Diagram. One figure: CL8Y token ↔ DEX; Bridge ↔ chains/assets; CMM treasury ↔ collateralized tokens and (optionally) DEX LP custody. Must appear in prerendered
dist/index.htmlwithout JS (inline SVG or equivalent). No three.js, no mermaid runtime, no remote image CDN. Accessible:svgwith<title>/ text labels, or a labeled HTML list that remains true if SVG CSS fails. Do not claim live volumes on the arrows.CTAs. Keep
dexHrefon home (utm_campaign=home). Add a Bridge link built withURL(not string concat, notwindow.location, not visitor query). Origin is first-partyhttps://bridge.cl8y.com— prefer a tested constant insrc/lib/over a new CoolifyVITE_*unless origin fail-closed already requires it.rel="noopener noreferrer"iftarget="_blank". Do not make “Buy CL8Y” the primary button. Do not deep-link third-party venues.Titles. Home
<title>may becomeStart here · CL8Y docs(must remain unique vs the other six routes). Updatesrc/seo.tsdescription.e2e/crawl.spec.tsand dist HTML tests must follow. Canonical stayshttps://docs.cl8y.com/.Guides index. Link Start Here (
/) from/guidesso the hub lists it beside Open the DEX. Do not duplicate the full manuscript on/guides.No wallet / trading UI. No wagmi, WalletConnect, LCD keys, or DEX screens.
Do not publish ops internals, unpublished marketing manuscripts, or extra contract addresses.
Relevant files
src/pages/HomePage.tsxsrc/pages/GuidesPage.tsx/as Start Heresrc/seo.tssrc/content/invariants.ts/onlysrc/lib/dexHref.tssrc/lib/(new small helper OK)src/data/contracts.tssrc/components/Layout.tsxe2e/crawl.spec.tsdocs/ARCHITECTURE.md§4 / §12docs/INVARIANTS.mdcode/ustr-cmmREADMEcode/CL8Y-web#1Recommended direction
src/content/startHere.ts(strings + asset rows) so unit tests can forbid banned hype and unverified claim patterns without rendering React.HomePage: H1 Start here; one-sentence what CL8Y is; sections Bridge / DEX / CMM; diagram; assets table; hub links. Keep Layout chrome.bridgeHref():new URL("/", "https://bridge.cl8y.com")(or baked origin). Unit-test rejection ofjavascript:/ foreign hosts if the helper accepts any input; if it is a constant, snapshot the href.UST1/USTRpermitted inHomePage/startHere.tsonly.Acceptance criteria
GET /prerendered HTML (no JS) contains a Start Here heading and plain-English explanations of CL8Y, Bridge, DEX, and CMM.uluna, and the CMM tokens named in Constraints. Extra assets only if already first-party documented. No new contract strings beyondsrc/data/contracts.tsunless copied from that file.https://bridge.cl8y.com(path/or documented first-party path only). DEX CTA still goes throughdexHrefwith execute ids +utm_campaign=home.<title>unique (Start here · CL8Y docsor equivalent); canonicalhttps://docs.cl8y.com/. Other six routes unchanged./guideslinks to Start Here at/. No new route.UST1/USTRappear only as factual CMM token names (or tests fail closed if they leak onto other stubs).npm test,npm run typecheck,npm run build+ dist unique-title tests, Playwright 5 workers stay green.Given a newcomer opens the prerendered home page at
/When they read Start Here without executing JavaScript
Then they can identify CL8Y, the Bridge, the DEX, and CMM, see how those parts connect, and see the purpose of the major first-party assets, with first-party Bridge and DEX links and no invented statistics
Test plan (functional paths)
dist/index.htmlcontracts.tsif shownhttps://bridge.cl8y.com;relsafe if new tabdexHrefdefault pair +utm_campaign=home/guidesHTML/labeled Start Here/methodology,/markets,/contractsGET /no-such-pageTest plan (copy safety)
Not a DeFi attack suite. Keep host crawl/CTA tests from #3 green.
/javascript:/data:/ protocol-relative Bridge href/methodologystub via shared layout/copy onlycontracts.tsVerification criteria
npm test&&npm run typecheck&& productionnpm run buildwith requiredVITE_*.npm run test:dist(unique titles/canonicals)./and confirm a newcomer can answer “what is CL8Y / Bridge / DEX / CMM?” from the page alone.python3/ existingscripts/check-origins.mjsstill fail-closed without HTTPS origins.Out of scope
Sitemap:pointer.code/CL8Y-web,code/ustr-cmm, or the DEX SPA.First-pass model recommendation
Recommendation: grok-high
Rationale: This is public newcomer-funnel copy across Bridge, DEX, and CMM, plus a bounded exception to
BANNED_CURRENT_COPYfor USTR/UST1 names, a prerendered diagram, SEO/title updates, and copy-safety tests. It is not docs/test-only maintenance of existing stubs: product claims must be sourced fromcontracts.ts, ARCHITECTURE §4, CL8Y-web #1, andustr-cmmwithout inventing metrics. Scope is more than three local production files in one helper (HomePage, seo, invariants/tests, optional Bridge helper, architecture/invariants docs). Uncertain asset list (what counts as “major”) and the copy-exception design fail the Composer rubric (known local edit, low ambiguity, no cross-product claim risk). Comparable control-plane calibration: a single RCA Markdown (#170) would be Composer; this spans content policy and prerender assertions more like a cross-module change than a test-helper tweak (#164).