Reorganize command-based documentation for v2/v3 separation (Phase 1) #3164
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Fixes NI forums linkcheck failure
Made a separate workflow so it runs hours later to avoid rate limits
Changed the cable to a USB-C one as non-beta XRPs use that, and updated the Micro USB link to one that's actually available. --------- Co-authored-by: sciencewhiz <sciencewhiz@users.noreply.github.com>
Fixes dependabot alerts Unpin urllib3 since it's no longer maintained
Update link to AdvantageScope 2025 changes to CD post, since removed from AdvantageScope website Update link to Spark Max getting started Ignore filezilla and miktex as they are blocking
also updated the description a bit
Python 3.9 will be out of support soon Update RTD to Ubuntu 22.04 since 20.04 is out of support
Appears to be unused and is unmaintained
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 24 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
Member
Author
|
Closing this PR - it was created from the wrong base branch (add-oxford-commas instead of 2027). Will recreate with proper base. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
10 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR reorganizes the existing command-based documentation into a
commands-v2/subdirectory to prepare for Commands v3 documentation. This is Phase 1 of the Commands v3 documentation project, addressing feedback from @SamCarlberg on PR #3095.Changes
File Organization
commands-v2/subdirectory (with git history preserved viagit mv)commands-v2/index.rstas the new landing page for Commands v2 documentationcommandbased/index.rstto serve as a high-level framework chooser between v2 and v3Cross-Reference Updates
commands-v2/prefixredirects.txtto ensure old URLs continue workingFiles Moved
what-is-command-based.rstcommands.rstcommand-compositions.rstsubsystems.rstbinding-commands-to-triggers.rststructuring-command-based-project.rstorganizing-command-based.rstcommand-scheduler.rstcpp-command-discussion.rstpid-subsystems-commands.rstprofile-subsystems-commands.rstprofilepid-subsystems-commands.rstRationale
This addresses the main concern from PR #3095 that the work was too large to review effectively. By splitting into phases:
Testing
Checklist
git mvcommands-v2/index.rstcreatedcommandbased/index.rstupdatedRelated to #3095
🤖 Generated with Claude Code