Skip to content

Set up Verso for auto-generated documentation #69

@Xinze-Li-Moqian

Description

@Xinze-Li-Moqian

Context

Site has been cleaned to a minimal landing page. Need proper documentation that stays in sync with code automatically.

Why Verso over doc-gen4

  • Verso covers doc-gen4's API reference features AND supports narrative docs (tutorials, guides)
  • Lean official docs use Verso
  • One tool instead of two
  • Embeds actual Lean code with hover, go-to-definition, proof state

Desired workflow

Write code (Astrolabe/Nerve.lean with docstrings)
  → Write demo (Demo/Astrolabe/Nerve.lean)
  → Write test (Test/Astrolabe/Nerve.lean)
  → Verso auto-extracts code + docstrings → site updates

Every new structure/method automatically appears in docs. No manual documentation maintenance.

Tasks

  • Evaluate Verso: clone, build, understand the authoring model
  • Prototype: write one Verso page that imports AstroNerve and shows its API
  • Decide: replace current Next.js site entirely, or doc section only?
  • Set up CI: Verso builds on every PR, deploys on merge to main
  • Integrate into lint.sh: docs must build (like demo must build)

References

Metadata

Metadata

Assignees

No one assigned

    Labels

    infrastructureBuild, CI, schemas, packaging, downstream tooling

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions