Skip to content

chore: update links in readme #1344

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 11, 2025
Merged

Conversation

nitisht
Copy link
Member

@nitisht nitisht commented Jun 11, 2025

Summary by CodeRabbit

  • Documentation
    • Updated and standardized documentation links in the README for improved accuracy and consistency.
    • Revised quickstart, installation, features, and contribution guide links to point to updated or more specific pages.

Copy link
Contributor

coderabbitai bot commented Jun 11, 2025

Walkthrough

This 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

File(s) Change Summary
README.md Updated and standardized documentation URLs for key concepts, features, quickstarts, installation, and contribution guide. No content or instruction changes.

Possibly related PRs

  • update docker image repo #1322: Updates Docker image repository and Helm chart metadata in documentation, related through Docker documentation references.

Poem

A hop and a skip, the links are all neat,
With URLs refreshed, our docs can't be beat!
From quickstarts to features, each path now aligns,
For readers and rabbits, the README now shines.
🐇✨


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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need 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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@nitisht
Copy link
Member Author

nitisht commented Jun 11, 2025

Skipping tests because this is doc change

@nitisht nitisht merged commit 970a5a5 into parseablehq:main Jun 11, 2025
3 of 4 checks passed
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

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

📥 Commits

Reviewing files that changed from the base of the PR and between caa9604 and 3f43d8b.

📒 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/distributed are 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 GitHub CONTRIBUTING.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)
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

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.

Suggested change
- [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".

@nitisht nitisht deleted the readme-links branch June 11, 2025 14:32
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