Repository navigation
feat(docs): migrate to VitePress - #105
Closed
aidil-coder-bot wants to merge 3 commits into
Closed
aidil-coder-bot wants to merge 3 commits into
aidil-coder-bot wants to merge 3 commits into
Conversation
- Replace Vue 3 SPA with VitePress documentation site - Bilingual: Indonesian (default) + English (/en/) - Guide: memulai, autentikasi, error handling, glosarium - API reference: 11 endpoint pages (health-check, national, provinces, regencies, hospitals, task-forces, vaccination, statistics) - Update Dockerfile: build with pnpm docs:build, serve from docs/.vitepress/dist - Add docs:dev, docs:build, docs:preview scripts
- Add ApiPlayground Vue component with live request capability - Add SSR-safe wrapper (ApiPlaygroundWrapper) using onMounted - Add playground to: health-check, national-latest, national-historical, provinces, province-cases, regencies, hospitals, vaccination, statistics, task-forces endpoints - Supports path params, query params, response display with status code & timing
Swagger UI already provides interactive testing. Playground is more appropriate for stadata_js SDK docs where users need to explore the API.
Contributor
|
Closing without merging. The redesign (PR #107, released as 1.6.0 and 1.6.1) is live on production. This PR changes the Dockerfile to build and serve the VitePress site, so merging it and cutting a release would replace the redesigned site. It also conflicts with the redesign in package.json and the lockfile. If a VitePress migration is still wanted, reopen it on top of current develop and decide first whether it should replace the Vue site. |
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
Migrates the documentation site from Vue 3 SPA to VitePress.
Changes
VitePress Site (
docs/)public/→docs/public/Dockerfile
pnpm build→pnpm docs:build/app/dist→/app/docs/.vitepress/distPackage.json
docs:dev,docs:build,docs:previewBuild
pnpm docs:build✅ succeeds locally