Skip to content

Documentation site — architecture, deployment, API and MCP reference #92

Description

@victorsoriadrp

Context

ArchiPulse currently has a README plus a single docs/schema.md. A dedicated documentation site is a v1.0 prerequisite for adoption beyond early evaluators.

Scope

  • Getting started (Docker Compose, env vars, first import)
  • Architecture overview (Go backend, embedded SPA, AOEF as relational schema)
  • Deployment (Docker, Helm — links to feat(ui): migrate all components to shadcn-svelte + Tailwind #7)
  • API reference (REST, generated from handlers or OpenAPI spec)
  • CLI reference
  • MCP server reference (tool catalogue with input/output schemas)
  • AOEF interoperability guide (round-trip with Archi, BiZZdesign, Sparx)
  • Contributing

Acceptance criteria

  • Static site generator chosen (Astro Starlight recommended — see project memory)
  • Hosted at docs.archipulse.org (Cloudflare Pages)
  • Search out of the box
  • Auto-deployed on push to main
  • Linked from the main website and README

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions