Skip to content

feat(docs): scaffolded#1

Merged
nekomeowww merged 2 commits into
mainfrom
nekomeowww/feat/docs-scaffold
Jul 16, 2026
Merged

feat(docs): scaffolded#1
nekomeowww merged 2 commits into
mainfrom
nekomeowww/feat/docs-scaffold

Conversation

@nekomeowww

@nekomeowww nekomeowww commented Jul 15, 2026

Copy link
Copy Markdown
Contributor

Summary

  • restructure the English and Simplified Chinese documentation navigation into Introduction and Learn paths
  • add progressive guides for tasks, assertions, model execution, matrices, reliability, reports, and comparisons
  • replace Config and API placeholders with source-verified lookup maps covering all 11 published package entrypoints
  • fully revise all 13 Simplified Chinese pages for natural, consistent technical Chinese
  • demonstrate rendered file labels, line/error/diff markers, and word highlighting in code examples

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:docs
  • pnpm typecheck
  • pnpm lint (only the existing empty-file warning)
  • pnpm exec vitest run --testTimeout=15000 (39 files, 272 tests passed)
  • rendered HTML checks for file tabs and line, word, error, add, and remove highlighting
  • locale coverage, placeholder, terminology, and git diff --check scans

Notes

The default pnpm test:run can 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.

@github-actions

github-actions Bot commented Jul 15, 2026

Copy link
Copy Markdown

Approval required for deploying to Cloudflare Workers (Preview) for docs.

Name Link
Waiting for approval For maintainers, approve here

@nekomeowww nekomeowww changed the title docs: scaffold bilingual documentation architecture feat(docs): scaffolded Jul 16, 2026
@nekomeowww
nekomeowww marked this pull request as ready for review July 16, 2026 05:36
@nekomeowww
nekomeowww merged commit 530b18d into main Jul 16, 2026
5 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