Skip to content

Separate Demo Site from Documentation Site #168

@lattln

Description

@lattln

Description

Currently, the documentation site (apps/mieweb-forms-docs) includes embedded demo pages (/editor-demo, /renderer-demo) that load the full @mieweb/forms-editor and @mieweb/forms-renderer packages.

This increases documentation page load time and couples demo deployments with documentation updates.

We should host apps/web-demo-packages as a standalone demo site and link to it from the documentation site instead of embedding demos directly.


Benefits

  • Faster documentation site load times (no heavy demo bundles)
  • Independent deployment cycles for docs and demo
  • Improved demo UX (full-screen layout, example selector, JSON import, multi-instance playground)
  • Simplified docs build process and bundle output

Scope / Tasks

  • Deploy apps/web-demo-packages as a standalone demo site
    (GitHub Pages or equivalent hosting)

  • Update docusaurus.config.js navbar to use external links (href)
    instead of internal routes for demo access

  • Remove embedded demo routes:

    • /editor-demo
    • /renderer-demo
  • Delete embedded demo components:

    • src/components/EditorDemo/
    • src/components/RendererDemo/
  • Update all internal documentation links pointing to:

    • /editor-demo
    • /renderer-demo
      to reference the external demo site
  • Verify documentation site bundle size is reduced after removal


Acceptance Criteria

  • Documentation site no longer bundles demo code
  • Demo site is independently accessible via a public URL
  • Docs navbar links open the demo site externally
  • No broken links remain in documentation
  • Documentation site build output is smaller than before

Notes

  • Demo URL to be finalized (e.g. https://demo.questionnaire-builder.opensource.mieweb.org)
  • Dark mode and advanced playground features for the demo site can be handled in follow-up tickets

Metadata

Metadata

Assignees

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions