fix error in docs regarding COF and PID tuning #48
Conversation
📝 WalkthroughWalkthroughThe pull request focuses on updating the Changes
Sequence DiagramsequenceDiagram
participant User
participant Documentation
participant TunerConstants
participant Robot
User->>Documentation: Read quickstart guide
Documentation->>User: Provide detailed configuration steps
User->>TunerConstants: Configure system constants
TunerConstants->>Robot: Apply updated parameters
Robot->>User: Perform system calibration and testing
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
docs/mkdocs/docs/quickstart.md (2)
204-208: Enhance plotting instructions and fix grammar.The addition of specific values to plot is helpful. However, let's improve clarity and fix grammar:
- Plot values for - /RealOutputs/SwerveStates/Measured - /RealOutputs/SwerveStates/SetpointsOptimized - Try to match the Measured value as close to Optimized as possible. - - Transitions won't be instant, but ensure that we don't over/under shoot + - Transitions won't be instant, but ensure that we don't overshoot or undershootConsider adding:
- Example plots showing good vs. poor matching
- Typical transition time expectations
- Acceptable tolerance ranges between measured and optimized values
🧰 Tools
🪛 LanguageTool
[uncategorized] ~208-~208: There appears to be a verb missing here. Did you mean “don't be over”?
Context: ...ns won't be instant, but ensure that we don't over/under shoot - Watch for: - ...(CANT_JJ)
418-421: Important update on wheel coefficient of friction values.The addition of specific COF values, especially the time-based degradation warning for the Billet Wheel, is crucial information.
Consider enhancing this section with:
- Impact of COF degradation on path following accuracy
- Recommended inspection/replacement intervals
- Signs that indicate when the wheel COF has degraded too much
- Best practices for maintaining consistent wheel performance across events
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/mkdocs/docs/quickstart.md(2 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/mkdocs/docs/quickstart.md
[uncategorized] ~208-~208: There appears to be a verb missing here. Did you mean “don't be over”?
Context: ...ns won't be instant, but ensure that we don't over/under shoot - Watch for: - ...
(CANT_JJ)
Summary by CodeRabbit