feat(docs): scaffolded#1
Merged
Merged
Conversation
Approval required for deploying to Cloudflare Workers (Preview) for docs.
|
nekomeowww
marked this pull request as ready for review
July 16, 2026 05:36
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
Why
The existing documentation was mostly skeletal and did not provide a coherent path from a first deterministic evaluation to execution policy, results, and failure diagnosis. This scaffold establishes that learning sequence while keeping Guide, Config, and API content distinct.
Impact
Readers can now complete a no-credentials first run, build a mental model of Vieval's tasks and results, and look up configuration domains or public import paths in both supported locales. The docs site now enables Shiki word highlighting explicitly.
Validation
pnpm build:docspnpm typecheckpnpm lint(only the existing empty-file warning)pnpm exec vitest run --testTimeout=15000(39 files, 272 tests passed)git diff --checkscansNotes
The default
pnpm test:runcan time out in the existing CLI shim test because that test performs a synchronous package build under Vitest's 5-second default timeout. The same test passes in isolation, and the full suite passes when the timeout is raised to 15 seconds.Existing uncommitted changes in the main workspace were not staged or modified.