Repository navigation
docs: separate user guides from comprehensive AI references - #1053
Merged
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub. |
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.
Result
The public docs now focus on complete user tasks: installation, clients, providers, features, deployment, recovery, and API lookup. All 73 public pages were reviewed against source; 71 detailed implementation references preserve the earlier content with source ownership, corrections, constraints, and verification targets.
Maintenance, feature-porting, design-system, brand-guide, prompt, and audit references now live under
internal/docs/. They are excluded from public routes, navigation, search, and copied brand assets. Canonical vector assets remain in the repository. Public asset synchronization clears stale notes and publishes runtime image formats only.Validation
Documentation integrity and provider-catalog checks, affected unit tests, root lint, production website build, and all seven browser tests pass. The browser suite covers every public docs route, search, mobile overflow, accessibility, demo navigation, and internal page/asset exclusion. The full separate-package CI gate passes: 11,985 passed, zero failures, 65 pending/skipped. Revision-bound commands, outcomes, and log hashes are retained in
internal/docs/documentation-verification.mdand.json.Baseline impact: no additions. Gateway, provider, database, authentication, and MITM runtime behavior remain unchanged; their documented contracts were checked against source. No live provider credentials were used.