fix(docs): fix linting issues - trailing spaces and EOF newline by ossdhaval · Pull Request #12835 · JanssenProject/jans (original) (raw)

📝 Walkthrough

Walkthrough

Widespread documentation edits: markdown formatting normalization (trailing-space/header fixes, end-of-file newline normalization), conversion of contribution list items to paragraphs, minor wording clarifications in a few OAuth/OpenID/token docs, and code-fence/formatting corrections across many README and guide files.

Changes

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~15 minutes

• Most edits are homogeneous formatting fixes; skim-review acceptable.
• Files needing focused review:
  • docs/janssen-server/auth-server/oauth-features/jwt-grant.md — verify the new aud claim validation wording is correct and unambiguous.
  • docs/janssen-server/auth-server/oauth-features/pkce.md — confirm PKCE phrasing correction is accurate.
  • docs/janssen-server/auth-server/tokens/oauth-refresh-tokens.md — ensure refresh-token behavior clarifications align with intended token lifecycle.

Possibly related issues

• fix(docs): fix linting issues - trailing spaces and EOF newline #12730 — Addresses markdown linting issues (trailing spaces, EOF newlines, list vs paragraph markers) that this PR also corrects.

Possibly related PRs

• fix(docs): fix linting issues - trailing spaces and EOF newline #12766 — Overlapping documentation edits and contribution-link wording fixes in similar files.
• fix(docs): fix linting issues - trailing spaces and EOF newline #12731 — Repository-wide markdown whitespace/newline cleanup with strong overlap to these changes.

Suggested reviewers

• manojs1978
• moabu
• devrimyatar

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

✅ Passed checks (2 passed)

✨ Finishing touches 🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch docs-remove-trailing-space-and-newline-issues

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 66732ae and a9b196b.

📒 Files selected for processing (3)

• docs/janssen-server/auth-server/oauth-features/dpop.md (3 hunks)
• docs/janssen-server/config-guide/auth-server-config/attribute-configuration.md (11 hunks)
• docs/janssen-server/config-guide/smtp-configuration.md (5 hunks) 🧰 Additional context used 🧠 Learnings (1) 📚 Learning: 2025-12-04T12:17:12.662Z

Learnt from: olehbozhok
Repo: JanssenProject/jans PR: 12797
File: jans-cedarling/AGENTS.md:82-88
Timestamp: 2025-12-04T12:17:12.662Z
Learning: In the jans-cedarling project, the AGENTS.md file is AI-generated and used only by AI agents, so markdown linting issues (such as MD031, MD040) for this file can be ignored during code reviews.

Applied to files:

• docs/janssen-server/auth-server/oauth-features/dpop.md 🪛 markdownlint-cli2 (0.18.1) docs/janssen-server/config-guide/auth-server-config/attribute-configuration.md

283-283: Code block style
Expected: indented; Actual: fenced

(MD046, code-block-style)

318-318: Code block style
Expected: indented; Actual: fenced

(MD046, code-block-style)

🔇 Additional comments (9)

docs/janssen-server/config-guide/smtp-configuration.md (6)

94-95: Fix spacing before inline code element.

Line 94 previously had a missing space before the backtick. The current version correctly reads "for --info", which aligns with markdown formatting conventions and addresses the past review feedback.

---

110-110: Remove extra whitespace between words.

The double space between "below" and "data" has been corrected to a single space. The line now properly reads "we have added below data to the file", addressing previous feedback.

---

163-165: Fix capitalization and spacing in sentence.

Line 164 now correctly capitalizes "Simply" (new sentence after period on line 163) and includes proper spacing: /tmp/smtp.json file (rather than the previous /tmp/smtp.jsonfile). These corrections address the past review feedback on text quality.

---

189-191: Verify text reflow for clarity.

Lines 189–191 have been reflowed. Confirm that the meaning remains intact: "Testing SMTP Server configuration token with https://jans.io/oauth/config/smtp.write scope is required." The restructuring appears intentional to improve flow.

---

197-198: Text improvement for readability.

Line 197 now reads "This will return status code 200 with a response as true or false based on the SMTP test result." The phrasing is clearer than before.

---

1-241: Verify end-of-file newline presence.

The PR objective includes ensuring files have a newline at EOF. The annotated code view does not clearly show the final newline character. Please confirm the file ends with a single newline character and does not have trailing whitespace on the last line.

docs/janssen-server/auth-server/oauth-features/dpop.md (2)

44-44: Spelling fix verified: "acertain" → "ascertain".

The correction from "acertain" to "ascertain" is accurate and improves clarity in the description of DPoP proof validation.

---

66-66: Trailing spaces and EOF newline verification passed.

Both lines 66 and 159 are clean: no trailing spaces remain and the file ends with a newline character as required.

docs/janssen-server/config-guide/auth-server-config/attribute-configuration.md (1)

1-540: Trailing spaces and line-specific violations need correction.

The file contains trailing spaces on multiple lines (24, 25, 30, 36, 37, 299, 301, 302, 426, 453, 512, 513, 527) that should be removed as part of the linting fixes. Additionally, markdownlint reports 91 errors in the file, with MD046 (code-block-style) violations appearing on lines 50, 55, 97, 111, and others—not on lines 283 and 318 as previously noted. The linting violations extend beyond code block styling to include line length (MD013), multiple blanks (MD012), heading format (MD019, MD041), and fence spacing (MD031). Verify whether the PR scope covers all of these violations or if the focus is narrowly on trailing spaces and EOF newlines only.

Likely an incorrect or invalid review comment.

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

Comment @coderabbitai help to get the list of available commands and usage tips.