Skip to content

Conversation

@jasondaming
Copy link
Member

Summary

This PR adds the structural outline for Commands v3 documentation with section headers and TODO notes describing what content should go in each section. This is Phase 2 of the Commands v3 documentation project, addressing feedback from @SamCarlberg on PR #3095.

This PR is for reviewing the documentation structure and organization only - no actual content is included yet.

Dependencies

This PR builds on PR #3165 (Phase 1: v2 reorganization). Review #3165 first.

Changes

Documentation Structure Created

Created 14 skeleton files in commands-v3/ directory:

  1. index.rst - Landing page with overview, quick examples, and navigation
  2. what-is-commands-v3.rst - Conceptual foundation and core concepts
  3. getting-started.rst - Hands-on tutorial for first v3 program
  4. mechanisms.rst - Deep dive into Mechanisms (v3's Subsystems)
  5. commands-and-coroutines.rst - Core command creation and coroutine API
  6. async-await-patterns.rst - Async/await helpers for orchestration
  7. command-compositions.rst - Traditional composition groups
  8. binding-commands-to-triggers.rst - Button bindings and triggers
  9. priorities-and-interrupts.rst - Priority system and interruption
  10. structuring-v3-project.rst - Code organization best practices
  11. testing-and-simulation.rst - Testing commands with simulation
  12. telemetry-and-debugging.rst - Enhanced telemetry and debugging
  13. migration-from-v2.rst - Migration guide from v2 to v3
  14. advanced-topics.rst - Advanced patterns and edge cases

What's Included in Each File

Each skeleton file contains:

  • Title and purpose: Brief description of what the article covers
  • Section headers: Organized outline of topics
  • TODO directives: Detailed descriptions of what content should be written in each section
  • Guidance for writers: Clear direction on examples, explanations, and code samples needed

What's NOT Included

  • No actual tutorial content or detailed explanations
  • No code examples or RLIs (those come in Phase 3)
  • Just structural planning and content descriptions

Example: what-is-commands-v3.rst

Each file follows this pattern:

# What is Commands v3?

.. todo:: This article introduces the conceptual foundation...

## Introduction

.. todo::
   - Recap the command-based pattern
   - Explain what's fundamentally different in v3 vs v2
   - Why imperative style was chosen
   - Brief history: v1 → v2 → v3

## The Problem v3 Solves

.. todo::
   **Learning Curve Issues:**
   - v2 requires understanding functional composition...
   (detailed description of what to write)

Rationale

This phase allows review of:

  • Documentation organization: Is the article structure logical?
  • Topic coverage: Are all important v3 features covered?
  • Article scope: Is each article focused on a clear topic?
  • Content descriptions: Are TODO notes clear enough for future writers?

By reviewing structure first, we can adjust organization before investing time in writing full content.

Based On

This outline is based on:

Next Steps (Phase 3)

After this structure is approved:

  1. Create example projects in wpilibjExamples with verified code
  2. Write content article-by-article with RLIs to examples
  3. Submit content in small reviewable PRs (2-3 articles at a time)

Review Focus

Please review:

  • Is the article organization logical?
  • Are any important topics missing?
  • Are any articles too broad or too narrow in scope?
  • Are the TODO descriptions clear for future content writers?
  • Does the structure match what teams need to learn v3?

Statistics

  • 14 files created
  • 1,213 lines added
  • ~50 KB total
  • Average 86 lines per file

Checklist

Related to #3095
Related to #3165

🤖 Generated with Claude Code

Move all Commands v2 documentation files into a commands-v2/ subdirectory to prepare for Commands v3 documentation. This is Phase 1 of the Commands v3 documentation project.

Changes:
- Move 12 v2 documentation files to commands-v2/ subdirectory (preserving git history)
- Create new commands-v2/index.rst as landing page for v2 docs
- Update main commandbased/index.rst to serve as high-level framework chooser
- Update 20 files with corrected cross-references to new v2 locations
- Add 12 redirects to ensure old URLs continue working

This reorganization addresses feedback on PR wpilibsuite#3095 to split the work into manageable phases. The next phase will add v3 documentation structure with TODO placeholders.

Related to wpilibsuite#3095
Move all Commands v2 documentation files into a commands-v2/ subdirectory to prepare for Commands v3 documentation. This is Phase 1 of the Commands v3 documentation project.

Changes:
- Move 12 v2 documentation files to commands-v2/ subdirectory (preserving git history)
- Create new commands-v2/index.rst as landing page for v2 docs
- Update main commandbased/index.rst to serve as high-level framework chooser
- Update 20 files with corrected cross-references to new v2 locations
- Add 12 redirects to ensure old URLs continue working

This reorganization addresses feedback on PR wpilibsuite#3095 to split the work into manageable phases. The next phase will add v3 documentation structure with TODO placeholders.

Related to wpilibsuite#3095
Create skeleton structure for Commands v3 documentation with section headers and TODO notes describing what content should go in each section. This phase establishes the documentation organization for review before content is written.

Files created:
- index.rst: Landing page with overview and quick examples
- what-is-commands-v3.rst: Conceptual foundation and core concepts
- getting-started.rst: Hands-on tutorial for first v3 program
- mechanisms.rst: Deep dive into Mechanisms (v3's Subsystems)
- commands-and-coroutines.rst: Core command creation and coroutine API
- async-await-patterns.rst: Async/await helpers for orchestration
- command-compositions.rst: Traditional composition groups
- binding-commands-to-triggers.rst: Button bindings and triggers
- priorities-and-interrupts.rst: Priority system and interruption
- structuring-v3-project.rst: Code organization best practices
- testing-and-simulation.rst: Testing commands with simulation
- telemetry-and-debugging.rst: Enhanced telemetry and debugging
- migration-from-v2.rst: Migration guide from v2 to v3
- advanced-topics.rst: Advanced patterns and edge cases

Each file contains:
- Section headers outlining the article structure
- TODO directives describing what content should be written
- Guidance for future content writers on what to include

No actual tutorial content or code examples are included - this is purely structural planning for review.

Related to wpilibsuite#3095
Related to wpilibsuite#3165
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant