Skip to content

docs: group JSON-RPC overview and JWT auth in one section#7318

Open
0xDevNinja wants to merge 1 commit into
ChainSafe:mainfrom
0xDevNinja:0xdevninja/issue-5211-combine-rpc-jwt-docs
Open

docs: group JSON-RPC overview and JWT auth in one section#7318
0xDevNinja wants to merge 1 commit into
ChainSafe:mainfrom
0xDevNinja:0xdevninja/issue-5211-combine-rpc-jwt-docs

Conversation

@0xDevNinja

@0xDevNinja 0xDevNinja commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

Summary of changes

The JWT authentication guide was under "Knowledge Base", separate from the JSON-RPC reference it describes. This groups them together.

Changes introduced in this pull request:

  • Moved knowledge_base/jwt_handling.mdreference/json-rpc/authentication.md (retitled "Authentication", sidebar_position: 1), so it sits right after the Overview in the JSON-RPC reference section.
  • Repointed the two links that referenced the old page (the Overview's Authentication paragraph and the method-filtering guide).

The move preserves the page content as-is; only its location and the two inbound links change.

Reference issue to close (if applicable)

Closes #5211

Other information and links

Part of ChainSafe/forest-docs-v2#87. Kept it as a sibling page under the JSON-RPC section rather than inlining everything into the Overview, since the auth guide is fairly long — happy to fold it directly into the Overview instead if you'd prefer a single page.

Change checklist

  • I have performed a self-review of my own code,
  • I have made corresponding changes to the documentation. All new code adheres to the team's documentation standards,
  • I have added tests that prove my fix is effective or that my feature works (if possible),
  • I have made sure the CHANGELOG is up-to-date. All user-facing changes should be reflected in this document.

Outside contributions

  • I have read and agree to the CONTRIBUTING document.
  • I have read and agree to the AI Policy document. I understand that failure to comply with the guidelines will lead to rejection of the pull request.

Summary by CodeRabbit

  • Documentation
    • Updated authentication-related links to point to the current reference page.
    • Renamed the authentication reference page title to a simpler “Authentication” label.
    • Improved sidebar ordering for the authentication docs section.

The JWT authentication guide lived under "Knowledge Base", away from the
JSON-RPC reference it documents. Move it into the JSON-RPC reference
section as a sibling `Authentication` page next to the Overview, so both
appear together in the sidebar, and repoint the two links that referenced
the old location.

Closes ChainSafe#5211
@0xDevNinja 0xDevNinja requested a review from a team as a code owner July 8, 2026 11:14
@0xDevNinja 0xDevNinja requested review from LesnyRumcajs and akaladarshi and removed request for a team July 8, 2026 11:14
@coderabbitai

coderabbitai Bot commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 495adc86-0e74-4942-b3d7-961d181b6183

📥 Commits

Reviewing files that changed from the base of the PR and between 70b335d and 28a6e0b.

📒 Files selected for processing (3)
  • docs/docs/users/guides/methods_filtering.md
  • docs/docs/users/reference/json-rpc/authentication.md
  • docs/docs/users/reference/json-rpc/overview.md
🔗 Linked repositories identified

CodeRabbit considers these linked repositories for cross-repo context during reviews:

  • filecoin-project/lotus (manual)

Walkthrough

Documentation link updates redirect references from the old jwt_handling knowledge base page to the new authentication reference page, and the authentication page's frontmatter title changed from "JWT Authentication" to "Authentication" with an added sidebar_position.

Changes

Documentation link and title updates

Layer / File(s) Summary
Authentication page frontmatter update
docs/docs/users/reference/json-rpc/authentication.md
Title changed from "JWT Authentication" to "Authentication"; sidebar_position: 1 added.
Update cross-references to authentication page
docs/docs/users/guides/methods_filtering.md, docs/docs/users/reference/json-rpc/overview.md
Links updated to point to ./authentication and ../reference/json-rpc/authentication instead of the old jwt_handling knowledge base page.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Suggested reviewers: sudo-shashank, hanabi1224

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately reflects moving JWT auth alongside the JSON-RPC overview in the docs.
Linked Issues check ✅ Passed The JWT auth guide was moved into the JSON-RPC reference next to Overview, satisfying the request to keep them together.
Out of Scope Changes check ✅ Passed The PR only updates docs paths, page metadata, and links, which are all directly related to the stated objective.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
✨ Simplify code
  • Create PR with simplified code

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

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Combine JSON-RPC overview and JWT Auth pages in docs

1 participant