Skip to content

Clarify URL-based document heading#11372

Open
Shazaanashraff wants to merge 1 commit into
wso2:masterfrom
Shazaanashraff:fix-url-based-heading
Open

Clarify URL-based document heading#11372
Shazaanashraff wants to merge 1 commit into
wso2:masterfrom
Shazaanashraff:fix-url-based-heading

Conversation

@Shazaanashraff
Copy link
Copy Markdown

Purpose
N/A (doc-only wording improvement)

Goals
Improve clarity in the heading for URL-based documentation.

Approach
Adjust the heading text for readability and consistency.

User stories
As a reader, I want clear headings to quickly find the right steps.

Release note
Clarify a heading in the API documentation guide.

Documentation
N/A (this PR is documentation)

Training
N/A

Certification
N/A (doc-only)

Marketing
N/A

Automation tests
Unit tests: Not run (doc-only)
Integration tests: Not run (doc-only)
Security checks
Followed secure coding standards? N/A (doc-only)
Ran FindSecurityBugs? N/A (doc-only)
No secrets committed? Yes

Samples
N/A

Related PRs
N/A

Migrations (if applicable)
N/A

Test environment
N/A (doc-only)

Learning
N/A

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 18, 2026

Warning

Rate limit exceeded

@Shazaanashraff has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 56 minutes and 3 seconds before requesting another review.

You’ve run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: ba7e0d82-1394-4e27-9ae0-cc1a62af813a

📥 Commits

Reviewing files that changed from the base of the PR and between b8e0d5d and f1953c2.

📒 Files selected for processing (1)
  • en/docs/api-design-manage/design/api-documentation/add-api-documentation.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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 and usage tips.

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.

1 participant