Skip to content

fix(docs): restore version and discovery correctness#177

Merged
mattsse merged 2 commits into
mainfrom
mattsse/docs-correctness
Jul 16, 2026
Merged

fix(docs): restore version and discovery correctness#177
mattsse merged 2 commits into
mainfrom
mattsse/docs-correctness

Conversation

@mattsse

@mattsse mattsse commented Jul 16, 2026

Copy link
Copy Markdown
Member

Summary

  • centralize the documented Alloy and Alloy Core versions and verify generated dependency snippets in CI
  • configure the canonical site URL, sitemap, robots policy, page metadata, and working Open Graph image
  • remove retired community references and replace shared RPC defaults with caller-supplied environment variables
  • move example templates outside the routed pages tree
  • replace the stale monolithic prompting page with a concise retrieval and verification guide for coding agents
  • make the examples generator safer and keep it aligned with the new template location

Why

The live site mixed Alloy 0.x, 1.x, 2.0, and 2.1 guidance, lacked a sitemap and canonical page URLs, exposed internal templates through public routes, and embedded shared infrastructure endpoints in runnable snippets. The prompting page duplicated most of the manual and recommended obsolete dependencies and feature names, which made the machine-readable corpus actively misleading.

Impact

Installation and individual-crate declarations now target the versions shown by the site, dependency snippets cannot drift unnoticed, public pages have canonical metadata, sitemap and robots files are generated, and 15 internal templates disappear from public routing. Networked snippets require explicit RPC_URL or WS_URL configuration, avoiding brittle shared endpoints and accidental credential patterns. Coding agents receive a short workflow that prioritizes canonical pages, runnable examples, exact docs.rs symbols, and compiler verification.

@mattsse
mattsse requested a review from grandizzy July 16, 2026 11:01
@mattsse
mattsse merged commit 70f8e69 into main Jul 16, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant