Skip to content

Documentation: Automate documentation sync from language repo #23

@SchoolyB

Description

@SchoolyB

Summary

Automate syncing documentation from the EZ language repo to the docs site, so documentation updates happen alongside code changes rather than requiring manual updates.

Current State

  • Documentation lives in language.ez repo
  • Language code lives in EZ repo
  • Updates require manually editing docs after adding features
  • Error codes are already synced automatically via GitHub Actions

Proposed Options

Option 1: Colocate docs with code

Keep markdown docs in the EZ repo alongside the code:

EZ/
├── pkg/stdlib/json.go
├── docs/stdlib/json.md
├── docs/language/types.md
└── ...

GitHub Action syncs EZ/docs/language.ez/src/pages/docs/

Option 2: Generate docs from code comments

Extract structured comments from Go source to generate documentation automatically.

Option 3: AI-assisted doc generation

Use Claude API to draft documentation based on code changes, opens PR for review.

Why Wait

  • Language is still evolving rapidly
  • Manual docs force thinking about API design from user perspective
  • Automation adds maintenance burden that may not pay off until language stabilizes

Target

v1.0 release


Related: SchoolyB/EZ#627

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions