Skip to content

docs: add hosted user and developer documentation#144

Merged
ApocDev merged 7 commits into
mainfrom
docs/user-guide
Jul 11, 2026
Merged

docs: add hosted user and developer documentation#144
ApocDev merged 7 commits into
mainfrom
docs/user-guide

Conversation

@ApocDev

@ApocDev ApocDev commented Jul 11, 2026

Copy link
Copy Markdown
Owner

Summary

  • add a VitePress documentation site with a task-oriented end-user guide, reference, troubleshooting, and real in-app screenshots
  • add an explanatory home page, PyOps-aligned theme, logo favicon, local search, and accessible expandable screenshots
  • rewrite the developer documentation around durable subsystem contracts and project-specific workflows
  • add a GitHub Pages build/deploy workflow using Vite+
  • restore TURD master detection for current Py data so the documented TURD workflow is available

Validation

  • vp check in docs/
  • VITEPRESS_BASE=/pyops/ vp run docs:build in docs/
  • Playwright navigation, links, images, desktop/mobile overflow, and screenshot-lightbox behavior
  • app checks for the TURD data fix

Closes #141

ApocDev added 7 commits July 10, 2026 22:14
Set up the VitePress site through an isolated Vite+ package and move the existing technical material into its Development section. Add the GitHub Pages workflow and repair repository references for the new paths.

Refs #141
Infer TURD masters from the planner sub-tech gate structure used by current pypostprocessing dumps while retaining support for the legacy marker.

Closes #143
Add task-oriented setup, planning, integration, Assistant, reference, and troubleshooting guides with real application screenshots and reusable VitePress components.\n\nRefs #141
Restore an explanatory home page, add the logo favicon, and make app screenshots accessible expandable lightboxes. Keep the visual language close to PyOps while retaining a reading-oriented sans-serif type stack.

Refs #141
Replace implementation-era notes with durable subsystem contracts, contributor workflows, and project-specific operational details. Point standard Tauri mechanics to the upstream documentation and remove the stale roadmap.

Refs #141
Keep the home page version-neutral and describe Pyanodons as the primary design target rather than a requirement.

Refs #141
Refocus the repository landing page on product orientation, releases, and contributor setup. Keep task instructions in the hosted guide and clarify that Pyanodons is the primary design target rather than a requirement.

Refs #141
@ApocDev ApocDev merged commit 3880691 into main Jul 11, 2026
3 checks passed
@ApocDev ApocDev deleted the docs/user-guide branch July 11, 2026 05:10
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.

Build hosted end-user and developer documentation site

1 participant