Documentation & Publishing - npm Package & GitHub Marketplace

[nathanclevenger]

Create comprehensive documentation and publish package to npm and GitHub Marketplace.

Part of: ROADMAP.md Package v1.0 (#46)

Due Date: 2025-10-24

Progress

• Write comprehensive README
• Create API documentation
• Write migration guide from other formats
• Create video tutorials
• Publish to npm registry
• Submit GitHub App to marketplace
• Announce on social media

Tasks

API Documentation

• Document all exported functions
• Add JSDoc comments
• Create API reference page
• Include code examples

Migration Guide

Write guides for migrating from:

• Linear roadmaps
• Jira epics
• GitHub Projects
• Plain markdown TODO lists

Video Tutorials

Create tutorials covering:

• Getting started with ROADMAP.md
• Installing and configuring GitHub App
• Syncing with Issues
• Using hierarchical roadmaps
• Best practices

Publishing

• Publish `@roadmapmd/parser` to npm
• Submit GitHub App to marketplace
• Create landing page at https://roadmap.md
• Write launch blog post
• Tweet announcement thread
• Post to relevant communities (HN, Reddit, Twitter)

Resources

• 📦 README: `ai/packages/roadmap.md/README.md`
• 📖 Spec: `ai/packages/roadmap.md/SPEC.md`
• 🏗️ GitHub App: `ai/packages/roadmap.md/GITHUB_APP.md`

---

Generated from ROADMAP.md

[linear]

PLAT-8