Skip to content

docs: fix README TOC order to match section order - #316

Merged
Siddhant-K-code merged 1 commit into
mainfrom
docs/fix-readme-toc-order
Aug 24, 2026
Merged

docs: fix README TOC order to match section order#316
Siddhant-K-code merged 1 commit into
mainfrom
docs/fix-readme-toc-order

Conversation

@SoulPancake

@SoulPancake SoulPancake commented Aug 24, 2026

Copy link
Copy Markdown
Member

The TOC listed Retries before Calling Other Endpoints, but the sections in the body appear in the opposite order (and all sibling SDKs list Calling Other Endpoints first). Reorder the two TOC entries and normalize spacing before the Calling Other Endpoints heading. No content removed.

This is to be able to synch the generator with the sdks using the templates and have a consistent ordering across SDKs.

Description

What problem is being solved?

How is it being solved?

What changes are made to solve it?

References

Review Checklist

  • I have clicked on "allow edits by maintainers".
  • I have added documentation for new/changed functionality in this PR or in a PR to openfga.dev [Provide a link to any relevant PRs in the references section above]
  • The correct base branch is being used, if not main
  • I have added tests to validate that the change in functionality is working as expected

Summary by CodeRabbit

  • Documentation
    • Updated the table of contents to include “Calling Other Endpoints” before “Retries.”
    • Improved spacing after the Write Assertions example.

The TOC listed Retries before Calling Other Endpoints, but the sections in the body appear in the opposite order (and all sibling SDKs list Calling Other Endpoints first). Reorder the two TOC entries and normalize spacing before the Calling Other Endpoints heading. No content removed.
@SoulPancake
SoulPancake requested a review from a team as a code owner August 24, 2026 09:16
Copilot AI lite review requested due to automatic review settings August 24, 2026 09:16
@coderabbitai

coderabbitai Bot commented Aug 24, 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: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 174c63fa-248c-4252-b451-427d46c62552

📥 Commits

Reviewing files that changed from the base of the PR and between 62fbd9a and a8840e8.

📒 Files selected for processing (1)
  • README.md

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.


Walkthrough

The README table of contents now places “Calling Other Endpoints” before “Retries”. A blank line separates the Write Assertions example from the next section.

Changes

README structure

Layer / File(s) Summary
Navigation and section spacing
README.md
The table of contents order was updated, and a blank line was added before “Calling Other Endpoints”.

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

Merge Risk: ⚪ Minimal · up to a8840

This localized documentation change only aligns the README table of contents with the existing section order and normalizes spacing; no actionable merge-blocking risk remains.

Suggested reviewers: aaguiarz

🚥 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 clearly and concisely describes the README table of contents order change.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/fix-readme-toc-order

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.

@codecov-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 69.93%. Comparing base (62fbd9a) to head (a8840e8).

❌ Your project status has failed because the head coverage (69.93%) is below the target coverage (80.00%). You can increase the head coverage or adjust the target coverage.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #316   +/-   ##
=======================================
  Coverage   69.93%   69.93%           
=======================================
  Files         142      142           
  Lines       10774    10774           
=======================================
  Hits         7535     7535           
  Misses       3239     3239           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the Python SDK README to keep the table of contents aligned with the actual section order (and consistent with sibling SDKs), without changing documentation content.

Changes:

  • Reordered the README TOC entries so Calling Other Endpoints appears before Retries.
  • Normalized whitespace before the Calling Other Endpoints heading to match surrounding formatting.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

@Siddhant-K-code
Siddhant-K-code added this pull request to the merge queue Aug 24, 2026
Merged via the queue into main with commit 1b9f90f Aug 24, 2026
41 checks passed
@Siddhant-K-code
Siddhant-K-code deleted the docs/fix-readme-toc-order branch August 24, 2026 09:55
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.

5 participants