René's URL Explorer Experiment


Title: fix(docs): serve JSON-LD in the HTML, fix sidebar spacing, and tighten the CLI guides by waleedlatif1 · Pull Request #6763 · simstudioai/sim · GitHub

Open Graph Title: fix(docs): serve JSON-LD in the HTML, fix sidebar spacing, and tighten the CLI guides by waleedlatif1 · Pull Request #6763 · simstudioai/sim

X Title: fix(docs): serve JSON-LD in the HTML, fix sidebar spacing, and tighten the CLI guides by waleedlatif1 · Pull Request #6763 · simstudioai/sim

Description: Follow-up to #6762. Summary Install command. --global → -g, which is what every comparable CLI documents. Drops the yarn tab: it read yarn global add sim, which works on Yarn 1 only — Yarn 2 removed global installs, so that command fails for anyone on a modern Yarn. Adds npx sim for running without installing. Trimmed the CLI guides: 1016 lines → 763, 12 callouts → 3. The pages had accumulated design rationale that belongs in code comments rather than user docs — why the filter grammar is JSON, why the config section naming is asymmetric, why an unexpected error keeps its stack trace. I surveyed how gh, Vercel, Turborepo, Deno, Bun and Supabase write their CLI docs: none carry that kind of justification, and callouts are reserved for content whose absence produces a wrong result, not for general asides. The three that remain are the pairing-code check, that sim logout does not revoke the key, and the --limit 100 default on batch-delete/batch-update, which silently truncates a larger match. Troubleshooting drops the entries whose error message already contained its own fix and keeps the seven whose cause is not obvious. JSON-LD never reached the HTML. All four structured-data blocks (WebSite, TechArticle, BreadcrumbList, SoftwareApplication) were rendered with next/script, which never emitted a script tag. Measured on a production build, /api-reference/getting-started contained zero