Skip to content

docs(VitePress): 📝 Add VitePress documentation#20

Merged
haskou merged 1 commit into
masterfrom
chore/fix-vitepress-docs
Jun 23, 2026
Merged

docs(VitePress): 📝 Add VitePress documentation#20
haskou merged 1 commit into
masterfrom
chore/fix-vitepress-docs

Conversation

@haskou

@haskou haskou commented Jun 23, 2026

Copy link
Copy Markdown
Owner

Summary

  • Add the VitePress documentation site structure and GitHub Pages workflow.
  • Fix reference overview links so VitePress no longer reports dead links during production builds.
  • Make yarn docs:preview build the site before serving it, so preview works from a clean checkout without an existing docs/.vitepress/dist directory.

Root Cause

vitepress build docs failed because reference pages linked to /reference while the generated index route is /reference/. vitepress preview docs also expected a built output directory to already exist, so it failed when run before a docs build.

Validation

  • yarn docs:build
  • yarn docs:preview starts successfully at http://localhost:4173/value-objects/ after cleaning generated VitePress output.

@codecov

codecov Bot commented Jun 23, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@haskou haskou changed the title docs: 📝 Fix VitePress build and preview commands docs(VitePress): 📝 Add VitePress documentation Jun 23, 2026
@haskou haskou marked this pull request as ready for review June 23, 2026 15:10
@haskou

haskou commented Jun 23, 2026

Copy link
Copy Markdown
Owner Author

@codex review

@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review: Didn't find any major issues. 👍

Reviewed commit: a8c6f56f2e

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

@haskou haskou merged commit c7b90d4 into master Jun 23, 2026
3 checks passed
@haskou haskou deleted the chore/fix-vitepress-docs branch June 23, 2026 15:19
haskou added a commit that referenced this pull request Jun 23, 2026
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