Skip to content

📦 ROADMAP.md Package v1.0 - Open Source Launch #46

@nathanclevenger

Description

@nathanclevenger

Launch the official ROADMAP.md parser, generator, and GitHub integration package as open source.

Overview

ROADMAP.md is an open standard for expressing project roadmaps in markdown with hierarchical organization. This epic tracks the development and launch of the official @roadmapmd/parser package and GitHub App.

Details

Due Date: 2025-10-24
Owner: @nathanclevenger
Priority: P0
Status: active

Goals

  1. Create production-ready npm package for parsing and generating ROADMAP.md files
  2. Build GitHub App for bi-directional sync between ROADMAP.md and Issues
  3. Publish comprehensive documentation and examples
  4. Launch to open source community

Workstreams

  • Core Package Development (5/8 tasks) - Parser, generator, and TypeScript types
  • GitHub Integration (0/7 tasks) - GitHub App, webhooks, bi-directional sync
  • Documentation & Publishing (1/6 tasks) - README, docs, npm publish, marketing

Benefits

  • Human-Readable: Markdown-first format anyone can understand
  • Version Control: Track roadmap changes like code
  • Hierarchical: Organize with folder structures (like CLAUDE.md)
  • AI-Friendly: Structured format for autonomous orchestration
  • GitHub Native: Seamless sync with Issues and Projects

Resources

  • 📄 Format Specification: `ai/packages/roadmap.md/SPEC.md`
  • 📦 Package Source: `ai/packages/roadmap.md/`
  • 🏗️ GitHub App Design: `ai/packages/roadmap.md/GITHUB_APP.md`
  • 🗺️ AI Roadmap: `ai/ROADMAP.md`

Generated from ROADMAP.md

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions