Skip to content

Add RPI workflow documentation and optimize getting-started guides #101

@WilliamBerryiii

Description

@WilliamBerryiii

Summary

Create comprehensive documentation for the RPI (Research → Plan → Implement) workflow and restructure the getting-started documentation for better discoverability.

Tasks

  • Create docs/rpi/ folder with workflow documentation
    • Overview (README.md)
    • Task Researcher guide
    • Task Planner guide
    • Task Implementor guide
    • Using Together walkthrough
  • Restructure docs/getting-started/ folder
    • Setup guide (README.md)
    • First workflow tutorial using RPI
  • Create docs/contributing/ folder index
  • Update root README.md
    • Add "Try the RPI Workflow" section
    • Add "What's Included" table
    • Replace Resources with Documentation table
    • Streamline for faster navigation
  • Add optional scripts guidance to getting-started README

Acceptance Criteria

  • All markdown files pass linting (npx markdownlint-cli2)
  • All files pass spell check (npx cspell)
  • Tables formatted with npm run format:tables
  • Cross-links between docs work correctly

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions