AI: propose dedicated documentation hosting section for Vale spec#5
Open
notactuallytreyanastasio wants to merge 1 commit into
Open
AI: propose dedicated documentation hosting section for Vale spec#5notactuallytreyanastasio wants to merge 1 commit into
notactuallytreyanastasio wants to merge 1 commit into
Conversation
Add a new "Dedicated documentation hosting" section to the Vale specification proposing a separate subdomain docs service (similar to hexdocs.pm). Covers publication pipeline, URL structure, locale handling, CDN/auth strategy for private docs, search, and Temper-specific features (per-backend API docs, literate .temper.md rendering, optional interactive playgrounds). Also includes decision graph analysis (155 nodes) comparing Vale to hex.pm across supply chain security, access control, and documentation hosting approaches. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Signed-off-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Signed-off-by: Robert Grayson <bobbbygrayson+github@gmail.com> delete graph data Signed-off-by: Robert Grayson <bobbbygrayson+github@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
What the new spec section covers
Why a separate service: Documentation hosting has fundamentally different operational characteristics than the registry -- read-heavy, rarely changes, benefits from CDN. Hex.pm learned this and split hexdocs.pm out. Vale should do the same.
Publication pipeline: 6-step async process triggered on version publish:
URL structure:
docs.vale.example/[libraryname]-- latest non-prereleasedocs.vale.example/[libraryname]/[semver]-- specific versiondocs.vale.example/[libraryname]/[semver]/b/[backendid]-- backend-specific docsPrivate docs auth: Redirect-based auth dance with single-use short-lived tokens and encrypted session cookies (Secure, HttpOnly, SameSite=Lax). More complex than integrated routes but enables independent CDN scaling.
Search: Locale-aware full-text search across all visible documentation. Separate indices per visibility group for private docs. Cross-library search for discoverability.
Temper-specific features:
Context: decision graph analysis
This PR also includes a decision graph (viewable via
deciduous serve) with 155 nodes analyzing:Alternatives considered
/l/[name]/docs/...)Test plan
#library-documentation,#libraryprofile) resolve correctly in mkdocs🤖 Generated with Claude Code