Skip to content

docs: add VitePress documentation site with navigation improvements - #17

Merged
antosubash merged 7 commits into
mainfrom
feature/jolly-saha
Mar 27, 2026
Merged

antosubash merged 7 commits into
mainfrom
feature/jolly-saha

Conversation

@antosubash

Copy link
Copy Markdown
Owner

Summary

  • Add complete VitePress documentation site covering all framework features (getting started, guide, frontend, CLI, testing, advanced, reference)
  • Fix top nav: split "Guide" into separate "Getting Started" and "Guide" entries, add "Advanced" section
  • Add curated "Next Steps" cross-section links to all 27 doc pages for better discoverability
  • Disable VitePress auto prev/next footer in favor of hand-curated navigation

Test plan

  • Run cd docs/site && npm install && npm run build — verify build completes with no errors
  • Run cd docs/site && npm run dev — verify site renders locally
  • Spot-check Next Steps links on a few pages to confirm they resolve correctly

…egies

- Created `api.md` for comprehensive API reference including interfaces, attributes, and types.
- Added `configuration.md` detailing appsettings structure, environment variables, and module-specific settings.
- Introduced `e2e-tests.md` for end-to-end testing setup and usage with Playwright.
- Documented integration tests in `integration-tests.md`, covering HTTP endpoint testing with `WebApplicationFactory`.
- Provided an overview of testing strategies in `overview.md`, outlining unit, integration, and end-to-end tests.
- Added `unit-tests.md` detailing unit testing practices, including service and validator tests, fake data generators, and event handler testing.
Fix top nav: split "Guide" into separate "Getting Started" and "Guide"
entries, add "Advanced" to nav bar. Add curated "Next Steps" sections to
all 27 doc pages with cross-section links for better discoverability.
Disable VitePress auto prev/next footer in favor of the manual links.
@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying simplemodule with  Cloudflare Pages  Cloudflare Pages

Latest commit: c161926
Status: ✅  Deploy successful!
Preview URL: https://ca9e0e0d.simplemodule.pages.dev
Branch Preview URL: https://feature-jolly-saha.simplemodule.pages.dev

View logs

@antosubash
antosubash merged commit ca18e8b into main Mar 27, 2026
2 checks passed
@antosubash
antosubash deleted the feature/jolly-saha branch March 27, 2026 23:09
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