chore: update links in readme #1344
Conversation
WalkthroughThis change updates the README.md file by revising and standardizing various documentation URLs. Links in sections such as "Key Concepts," "Features," "FAQ," quickstart guides, distributed installation instructions, and contribution guidelines were updated to reflect new or more accurate documentation paths. No code or content changes were made. Changes
Possibly related PRs
Poem
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
Skipping tests because this is doc change |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
README.md (1)
98-98: Typographical nit: hyphenate “Role-based.”
Standard usage calls for “Role-based access control” with a hyphen.-[Role based access control ↗︎](https://www.parseable.com/docs/features/rbac) +[Role-based access control ↗︎](https://www.parseable.com/docs/features/rbac)🧰 Tools
🪛 LanguageTool
[uncategorized] ~98-~98: This expression is usually spelled with a hyphen.
Context: ....parseable.com/docs/features/alerts) - [Role based access control ↗︎](https://www.parseabl...(BASED_HYPHEN)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(5 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[uncategorized] ~98-~98: This expression is usually spelled with a hyphen.
Context: ....parseable.com/docs/features/alerts) - [Role based access control ↗︎](https://www.parseabl...
(BASED_HYPHEN)
🔇 Additional comments (7)
README.md (7)
16-16: Header links updated correctly.
All navigation links now point to the updated Parseable.com docs paths.
29-29: Quickstart Docker link updated.
The Docker Image quickstart now uses/docs/quickstart/docker. Looks good.
44-44: Binary quickstart link updated.
The Executable Binary section now points to/docs/quickstart/binary. Good catch.
90-91: Distributed installation links standardized.
Helm and Binary installation links under/docs/installation/distributedare consistent and correct.
95-97: Feature links for key capabilities.
High Availability, Smart Cache, and Alerts links are all pointing to their respective, up-to-date documentation pages.
100-100: OpenTelemetry link updated.
OpenTelemetry support now links to/docs/OpenTelemetry/logs. Please confirm that the uppercase path is valid on the hosted docs site.
128-128: Direct contribution link.
Great improvement to link directly to the GitHubCONTRIBUTING.md.
| - [Smart cache ↗︎](https://www.parseable.com/docs/features/smart-cache) | ||
| - [Alerts ↗︎](https://www.parseable.com/docs/features/alerts) | ||
| - [Role based access control ↗︎](https://www.parseable.com/docs/features/rbac) | ||
| - [OAuth2 support ↗︎](https://www.parseable.com/docs/features/oepnid) |
There was a problem hiding this comment.
Broken OAuth2 docs link.
The path segment oepnid appears to be a typo. It should likely read openid (e.g., /docs/features/openid).
-[OAuth2 support ↗︎](https://www.parseable.com/docs/features/oepnid)
+[OAuth2 support ↗︎](https://www.parseable.com/docs/features/openid)📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - [OAuth2 support ↗︎](https://www.parseable.com/docs/features/oepnid) | |
| - [OAuth2 support ↗︎](https://www.parseable.com/docs/features/openid) |
🤖 Prompt for AI Agents
In README.md at line 99, the OAuth2 support link contains a typo in the URL path
segment "oepnid". Correct the URL by changing "oepnid" to "openid" so the link
points to the proper documentation path "/docs/features/openid".
Summary by CodeRabbit