Skip to content

feat(docs): add VitePress documentation site under /docs - #365

Open
ParvikaShekhawat wants to merge 4 commits into
ioflux-org:mainfrom
ParvikaShekhawat:feature/docs_update
Open

feat(docs): add VitePress documentation site under /docs#365
ParvikaShekhawat wants to merge 4 commits into
ioflux-org:mainfrom
ParvikaShekhawat:feature/docs_update

Conversation

@ParvikaShekhawat

Copy link
Copy Markdown
Contributor

Summary

Adds a full documentation site for JSON Schema Studio, built with VitePress, hosted at studio.ioflux.org/docs — implementing the approach the team discussed and agreed on in an earlier thread (same repo, subpath hosting, no separate domain/DNS needed).

Includes:

  • Full docs content: Introduction, Why JSON Schema Studio, Quick Start, Installation, Tech Stack, Understanding the Visualization, How It Works, Controls, FAQ & Known Issues, Roadmap, Contributing Guide, Versioning & Changesets
  • Collapsible sidebar navigation, local search, light/dark theming matching app branding
  • "Edit this page on GitHub" + last-updated timestamp on every page
  • Updated the in-app "Documentation" navbar button to link to /docs instead of the GitHub README
  • Updated deploy.yml to build the docs site and merge it into dist/docs/ before the existing GitHub Pages deploy step (no other workflow steps changed)
  • Added docs:build / docs:dev convenience scripts to the root package.json

What kind of change does this PR introduce

New feature (documentation)

Issue Number

Closes #69

Screenshots/Video

output.2.mp4

Does this PR introduce a breaking change?

No.

If relevant, did you update the documentation?

Yes — this PR is the documentation update. Added a new standalone docs site under /docs, and linked to it from the app's navbar.

Signed-off-by: ParvikaShekhawat <shekhaparvika2110@gmail.com>
@github-actions

github-actions Bot commented Jul 14, 2026

Copy link
Copy Markdown
Contributor

Preview Deployed!

Item Status
Latest Deploy Visit Preview
Environment Preview (PR-365)
Action View Logs

Last updated at 2026-07-25T18:23:58Z

Signed-off-by: ParvikaShekhawat <shekhaparvika2110@gmail.com>
@ParvikaShekhawat
ParvikaShekhawat marked this pull request as draft July 14, 2026 06:34
@ParvikaShekhawat
ParvikaShekhawat marked this pull request as ready for review July 18, 2026 16:52
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.

Creating a single page for tool docs

1 participant