docs: add Flake8, PHPMD, PHPCS to template & reference (#428) #429
Conversation
WalkthroughThe documentation and configuration template were updated to include three new static analysis tools: Flake8, PHPMD, and PHPCS. These tools are now described in the configuration reference, added to the YAML template with enabled flags, and included in the documentation sidebar under supported tools. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Docs
participant ConfigTemplate
participant Sidebar
User->>Docs: View configuration reference
Docs->>User: Show Flake8, PHPMD, PHPCS sections
User->>ConfigTemplate: View .coderabbit.yaml template
ConfigTemplate->>User: Show flake8, phpmd, phpcs enabled by default
User->>Sidebar: Browse supported tools
Sidebar->>User: Display Flake8, PHPMD, PHPCS entries
Assessment against linked issues
Poem
Impact AnalysisDocumentation sidebar updated to include Flake8, PHPCS, and PHPMD toolsℹ️ Low 🔄 Impacts behavior Users will now see Flake8, PHPCS, and PHPMD listed under the "Supported tools" section in the documentation sidebar, making it easier to access information about these static analysis tools. This change improves navigation but does not affect application functionality or user workflows. Verify that the documentation sidebar displays the new entries for Flake8, PHPCS, and PHPMD under "Supported tools" and that the links navigate to the correct documentation sections. 📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
✨ Finishing Touches
🧪 Generate unit tests
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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 (4)
docs/reference/yaml-template.md (1)
110-126: Alphabetical order nit-pick for the PHP tool entriesThe new PHP tool entries were added as
phpmd phpcs
phpcsshould come beforephpmdto keep the list in (case-insensitive) alphabetical order, matching the rest of the template.- phpmd: - enabled: true - phpcs: - enabled: true + phpcs: + enabled: true + phpmd: + enabled: truedocs/tools/flake8.md (1)
24-31: Format CLI options as code for consistency & readabilityThe option flags
--selectand--extend-ignorerender as plain text.
Surrounding them with back-ticks matches the rest of our docs style and lets them render as code.-- Select / ignore rule filtering (--select, --extend-ignore) +- Select / ignore rule filtering (`--select`, `--extend-ignore`)docs/reference/configuration.md (2)
2853-2891: Minor wording / breadcrumb inconsistencyMost tool sections use the pattern “Review > Tools > Tool-Name > Enable” for Location.
Here it reads “Review > Tools > Enable Flake8”, dropping the intermediate tool name segment.
Consider aligning it for search consistency:- <td>Review > Tools > Enable Flake8</td> + <td>Review > Tools > Flake8 > Enable</td>Same applies to Default row directly above ‑ no change needed.
3715-3794: Section ordering breaks PMD’s flowThe new PHPMD and PHPCS blocks were inserted between the Enable PMD subsection and PMD’s Config File subsection.
This splits PMD’s documentation in two and can confuse readers.Recommend moving the PHPMD / PHPCS blocks below the entire PMD section (after the PMD Config File table) or giving them their own top-level heading outside of the PMD section.
No diff supplied because the move spans large non-contiguous regions.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
docs/reference/configuration.md(2 hunks)docs/reference/yaml-template.md(2 hunks)docs/tools/flake8.md(1 hunks)
🧰 Additional context used
🧠 Learnings (3)
docs/reference/yaml-template.md (1)
Learnt from: alexcoderabbitai
PR: coderabbitai/coderabbit-docs#0
File: :0-0
Timestamp: 2025-06-02T14:07:49.512Z
Learning: For files in docs/tools/*.md directory: Do not recommend installation instructions or usage setup steps. All tools documented in this directory are pre-installed in CodeRabbit's default environment and require no installation steps from users. Documentation should focus on tool capabilities and features only.
docs/tools/flake8.md (1)
Learnt from: alexcoderabbitai
PR: coderabbitai/coderabbit-docs#0
File: :0-0
Timestamp: 2025-06-02T14:07:49.512Z
Learning: For files in docs/tools/*.md directory: Do not recommend installation instructions or usage setup steps. All tools documented in this directory are pre-installed in CodeRabbit's default environment and require no installation steps from users. Documentation should focus on tool capabilities and features only.
docs/reference/configuration.md (1)
Learnt from: alexcoderabbitai
PR: coderabbitai/coderabbit-docs#0
File: :0-0
Timestamp: 2025-06-02T14:07:49.512Z
Learning: For files in docs/tools/*.md directory: Do not recommend installation instructions or usage setup steps. All tools documented in this directory are pre-installed in CodeRabbit's default environment and require no installation steps from users. Documentation should focus on tool capabilities and features only.
🔇 Additional comments (1)
docs/tools/flake8.md (1)
1-37: Good: no installation instructions – complies with docs/tools guideline
|
@hardikkgupta - i noticed this in one of the nitpick comments above. I think this is important to fix: "The new PHPMD and PHPCS blocks were inserted between the Enable PMD subsection and PMD’s Config File subsection. Recommend moving the PHPMD / PHPCS blocks below the entire PMD section (after the PMD Config File table) or giving them their own top-level heading outside of the PMD section." |
|
@hardikkgupta - this seems important to fix too: "Format CLI options as code for consistency & readability The option flags --select and --extend-ignore render as plain text. |
docs/tools/flake8.md
Outdated
| @@ -0,0 +1,37 @@ | |||
| --- | |||
There was a problem hiding this comment.
This was already added in durring
https://github.com/coderabbitai/coderabbit-docs/pull/431/files
There was a problem hiding this comment.
So shall I remove that file from PR then?
There was a problem hiding this comment.
Yeah, I'd say so.
However, it looks like Flake8 never got added to sidebars.ts, so this is a good opportunity to add that!
There was a problem hiding this comment.
Changed! Let me know if this works!
Add Flake8, PHPMD & PHPCS to template / reference
Add Flake8 to tools folder as well
Fixes #428