Skip to content

Commit ec3ffac

Browse files
mikeraclaude
andcommitted
docs: mark DX_PLAN ship/link-check items done
Golden path deployed to docs.convex.world and convex.world; Lisp-guide fixed; docs link-check added (broken CAD links fixed, onBrokenLinks: throw, ci.yml build-check). All DX next-steps complete. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 8f2036a commit ec3ffac

1 file changed

Lines changed: 16 additions & 12 deletions

File tree

DX_PLAN.md

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -63,18 +63,19 @@ repos; **deploy pending** (§3).
6363
- [x] **convex.world hero** (`src/components/Hero.tsx`) — added a primary "Start building" CTA →
6464
`/developers`; kept Sandbox; demoted Vision to secondary.
6565

66-
Still open from the original scope: the **Lisp-guide sandbox block** (`convex-lisp/lisp-guide.md`,
67-
~lines 22-30) is still commented out — uncomment it so the language guide has a runnable first
68-
example (§3).
66+
The **Lisp-guide sandbox block** (`convex-lisp/lisp-guide.md`) has since been uncommented and now
67+
leads the guide, which was also corrected (see §4).
6968

7069
---
7170

7271
## 3. Next steps
7372

74-
**Ship it (deploy the committed work):**
75-
- `design` → docs.convex.world deploys on **master** push: `git -C design push origin master`.
76-
- `convex.world` hero deploys on **master**: merge `develop``master`. (convex `README` is
77-
already on `develop`; no deploy needed.)
73+
**Ship it — DONE (2026-06-22): all deployed and verified live.**
74+
- `design`**docs.convex.world** live (golden-path quickstart, fixed SDK quickstarts, corrected
75+
Lisp guide, naming sweep, link-check).
76+
- `convex.world`**live** as a full `develop``master` release (the hero + ~10 accumulated team
77+
commits). Fixed a `pnpm/action-setup` version-vs-`packageManager` conflict that had blocked
78+
every convex.world deploy since March.
7879

7980
**Verify (before/after shipping):**
8081
- [x] **Per-language SDK quickstarts** — verified and fixed (2026-06-19). Each was broken or
@@ -86,17 +87,20 @@ example (§3).
8687
package; Java live spot-checked on the testnet.
8788
- [x] **Java testnet example** — live spot-checked (`ConvexJSON` + `useNewAccount` → transact →
8889
query → `JAVA_OK`); this also confirms the top-level quickstart's Java example.
89-
- [ ] **Lisp-guide sandbox block** — uncomment and verify it runs.
90+
- [x] **Lisp-guide sandbox block** — uncommented (now leads the guide); also fixed several wrong
91+
outputs (verified live), the quote/unquote → quasi-quote error, an unclosed paren and typos,
92+
localised the screenshots, and added clojure syntax highlighting.
9093

9194
**Keep one-line-swap items from scattering again:**
9295
- The **testnet endpoint** `mikera1337-convex-testnet.hf.space` is still a placeholder for a
9396
proper branded testnet. It now appears in the quickstart, README, and SDK examples — keep each
9497
surface's value in one place so the eventual swap stays cheap.
9598

96-
**CI hygiene (cheap, high-leverage):**
97-
- Add a **docs link-check** to design CI — the build only warns on broken links
98-
(`onBrokenLinks: 'warn'`), and three are still broken (`overview/* → cad/*/README.md` in
99-
`faq.md`, `lattice.md`, `use-cases.md`). Good first cleanup plus a guard.
99+
**CI hygiene:**
100+
- [x] **Docs link-check — DONE (2026-06-22).** Fixed the 5 broken `overview/* → cad/*/README.md`
101+
links (use absolute `/docs/cad/<name>`; Docusaurus strips the numeric dir prefix), set
102+
`onBrokenLinks: 'throw'` so `pnpm build` fails on broken links, and added a `ci.yml` build-check
103+
on PRs / branch pushes.
100104
- Optional **version-drift guard**: a grep check that fails when a published surface disagrees
101105
with the released `pom.xml` / package version.
102106

0 commit comments

Comments
 (0)