fix(docs): capitalization, formatting, and command syntax corrections… #12743
Conversation
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
📝 WalkthroughWalkthroughDocumentation-only edits to Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes
Suggested labels
Suggested reviewers
Listen up, my friend — quick, tidy doc edits; nothing wild. Pre-merge checks and finishing touches❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: ASSERTIVE Plan: Pro 📒 Files selected for processing (1)
🧰 Additional context used🧠 Learnings (1)📚 Learning: 2025-10-30T15:21:12.720ZApplied to files:
🔇 Additional comments (1)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (1)
docs/contribute/testing.md(6 hunks)
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-10-30T15:21:12.720Z
Learnt from: ossdhaval
Repo: JanssenProject/jans PR: 12539
File: docs/janssen-server/auth-server/client-management/software-statements.md:29-29
Timestamp: 2025-10-30T15:21:12.720Z
Learning: In the Janssen Project documentation (docs/ directory), relative links in markdown files work correctly when tested locally even when intermediate directory segments like "janssen-server" appear to be missing from the relative path. The documentation build system handles path resolution appropriately, so local testing by developers is authoritative for verifying link correctness.
Applied to files:
docs/contribute/testing.md
🪛 LanguageTool
docs/contribute/testing.md
[grammar] ~94-~94: Ensure spelling is correct
Context: ...to use OpenBanking. ### Testing Using Commnd Line Mode We can run the below command...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🪛 markdownlint-cli2 (0.18.1)
docs/contribute/testing.md
16-16: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
17-17: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
20-20: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
29-29: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
43-43: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
94-94: Multiple spaces after hash on atx style heading
(MD019, no-multiple-space-atx)
🔇 Additional comments (1)
docs/contribute/testing.md (1)
16-106: Capitalization and content improvements look solid!The heading capitalization updates ("Unit Testing", "Component Testing", "Performance Testing", etc.) improve consistency and readability across the documentation. The added note about hyphen syntax (line 102-105) is particularly helpful for users copying command-line examples. The command block formatting corrections and refinements to section titles align well with the PR objectives.
Ensure the linting issues mentioned above are resolved locally (as noted in the PR checklist: "run static code analysis locally"), then the changes will be documentation gold!
There was a problem hiding this comment.
Actionable comments posted: 3
♻️ Duplicate comments (3)
docs/contribute/testing.md (3)
29-30: Add blank line after section heading (MD022).Line 29 is missin' that blank line below the heading. Let's tighten this up:
## Performance Testing + Performance tests are critical to optimization of the persistence and caching implementation.
94-94: Fix heading: correct typo "Commnd" → "Command" and remove extra spaces (MD019).You better think twice on this one! The previous review flagged this exact issue. The heading still contains:
- A spelling error: "Commnd" should be "Command"
- Multiple spaces after the hash (MD019 violation)
Let's get this party rollin' and fix it properly:
-### Testing Using Commnd Line Mode +### Testing Using Command Line Mode
43-44: Add blank line after section heading (MD022).Line 43 is missin' its blank line separator. Let's keep the markdown clean and consistent:
## Penetration Tests + Penetration testing is highly deployment specific. Depending on different implementations of the Janssen Project
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (1)
docs/contribute/testing.md(4 hunks)
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-10-30T15:21:12.720Z
Learnt from: ossdhaval
Repo: JanssenProject/jans PR: 12539
File: docs/janssen-server/auth-server/client-management/software-statements.md:29-29
Timestamp: 2025-10-30T15:21:12.720Z
Learning: In the Janssen Project documentation (docs/ directory), relative links in markdown files work correctly when tested locally even when intermediate directory segments like "janssen-server" appear to be missing from the relative path. The documentation build system handles path resolution appropriately, so local testing by developers is authoritative for verifying link correctness.
Applied to files:
docs/contribute/testing.md
🪛 LanguageTool
docs/contribute/testing.md
[grammar] ~21-~21: Use a hyphen to join words.
Context: ...nent Testing Component testing uses real world use cases to exercise a portion of...
(QB_NEW_EN_HYPHEN)
[style] ~36-~36: ‘under stress’ might be wordy. Consider a shorter alternative.
Context: ...to understand your system’s performance under stress. The [Benchmarking Documentation](../ja...
(EN_WORDINESS_PREMIUM_UNDER_STRESS)
[grammar] ~51-~51: Ensure spelling is correct
Context: ...ndency vulnerabilities are monitored by Gihub. In addition we plan to use the [Linux ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~94-~94: Ensure spelling is correct
Context: ...to use OpenBanking. ### Testing Using Commnd Line Mode We can run the below command...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🪛 markdownlint-cli2 (0.18.1)
docs/contribute/testing.md
20-20: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
29-29: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
38-38: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
43-43: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
94-94: Multiple spaces after hash on atx style heading
(MD019, no-multiple-space-atx)
🔇 Additional comments (2)
docs/contribute/testing.md (2)
20-21: Add blank line after section heading (MD022).You better think twice on this one! Line 20 needs a blank line below the heading to pass markdown linting. Let's get this party rollin' by addin' that blank line:
## Component Testing + Component testing uses real world use cases to exercise a portion of the software, using typical data inputs.
100-106: Review command block structure and trailing blank lines.Lines 100–106 contain excessive blank lines between two identical code blocks with an orphaned numbered item ("3. Important:") in between. The structure appears malformed:
[code block ends at 100] [blank line 101] [blank line 102] 3. **Important:** Check that the `–` before `operation-id`... [blank line 103] [code block starts at 104]This looks like incomplete editing where numbered list context was lost. Please clarify the intended structure: should this be a single code block with inline commentary, or should the structure be reorganized to make sense as a proper list or series of steps?
Signed-off-by: Vijayshree <[email protected]>
|
Hi @mo-auto and @yurem, the PR is now signed off (DCO passed) and all markdown lint issues are fixed. @coderabbitai[bot] has approved it. Could you please review and merge? Thanks! |
|
Tip For best results, initiate chat on the files or code changes. 🧩 Analysis chain🏁 Script executed: Length of output: 11007 @Vijayshree25, listen up, my friend! Like a wise ol' pigeon, I can confirm that I did indeed approve this PR after ya fixed those formatting issues. Nice work gettin' this party rollin'! 🎉 I see that the Snyk and CodeRabbit checks have passed with flying colors. However, I noticed the DCO (Developer Certificate of Origin) check is showin' "ACTION_REQUIRED". You might want to double-check that before the maintainers can merge this beauty. The maintainers @mo-auto and @yurem will need to give their human review and approval before this can be merged. You better think twice and make sure everything's in order! Keep up the good work on cleanin' up those docs! 📚 |
|
Tip For best results, initiate chat on the files or code changes. 🧩 Analysis chain🏁 Script executed: Length of output: 11117 @Vijayshree25, listen up, my friend! Like a wise ol' pigeon, I've checked the current status of your PR and here's what I'm seein': Good news 🎉:
Not-so-good news
You better think twice and double-check that DCO! The status shows it hasn't passed yet. You might need to:
What's needed for merge:
Once you fix that DCO issue and get maintainer approval, this beauty will be ready to roll! Let's get this party rollin'! 🚀 |
|
The PR is now ready for merge:
Could you please review and merge? Thanks! |
|
Tip For best results, initiate chat on the files or code changes. 🧩 Analysis chain🏁 Script executed: Length of output: 12534 @Vijayshree25, listen up, my friend! Like a wise ol' pigeon, I've checked the current status and here's what I'm seein': Good news 🎉:
The DCO situation 🤔:
You have 3 commits in this PR. You better think twice and verify that all three commits have the DCO sign-off, not just the latest one. What's still needed:
To fix the DCO: git rebase HEAD~3 --signoff
git push --force-with-leaseOnce that DCO check turns green and you get maintainer approval, this beauty will be ready to roll! Let's get this party rollin'! 🚀 |
3 participants
… for issue #12742
Prepare
Description
Target issue
closes #issue-number-here
Implementation Details
Test and Document the changes
Please check the below before submitting your PR. The PR will not be merged if there are no commits that start with
docs:to indicate documentation changes or if the below checklist is not selected.Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.