-
Notifications
You must be signed in to change notification settings - Fork 28
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
update docs links #320
update docs links #320
Conversation
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
📝 WalkthroughWalkthroughThe pull request involves modifications to the Possibly related PRs
Suggested reviewers
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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 (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (1)
README.md (1)
33-36
: Approve link updates and suggest indentation fix.The updated links provide a more organized structure for the API documentation. However, there's a minor formatting issue with the list indentation.
Consider adjusting the indentation of the sub-list items to match the parent list style:
- [API docs](https://docs.jamsocket.com/y-sweet) - - [TypeScript client](https://docs.jamsocket.com/y-sweet/reference/client) - - [React hooks](https://docs.jamsocket.com/y-sweet/reference/react) - - [Document management SDK](https://docs.jamsocket.com/y-sweet/reference/sdk) + [API docs](https://docs.jamsocket.com/y-sweet) + - [TypeScript client](https://docs.jamsocket.com/y-sweet/reference/client) + - [React hooks](https://docs.jamsocket.com/y-sweet/reference/react) + - [Document management SDK](https://docs.jamsocket.com/y-sweet/reference/sdk)This change will improve the consistency of the list formatting throughout the document.
🧰 Tools
🪛 Markdownlint
34-34: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
35-35: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
36-36: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
- README.md (1 hunks)
🧰 Additional context used
🪛 Markdownlint
README.md
34-34: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
35-35: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
36-36: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
🔇 Additional comments (2)
README.md (2)
37-37
: Approve link update and wording change.The updated link and text change from "Y-Sweet Cloud" to "Y-Sweet on Jamsocket" provide more clarity about the hosting service. This change is consistent with the earlier updates and improves the overall documentation accuracy.
33-37
: Summary of README.md updates.The changes to the README.md file effectively update the documentation links and improve clarity. The migration to Jamsocket-related links suggests a closer integration or partnership with Jamsocket. These updates enhance the organization and accessibility of the documentation while maintaining the core content and functionality of the Y-Sweet project.
Key improvements:
- Updated API documentation links with a more organized structure.
- Clarified the hosting service as "Y-Sweet on Jamsocket".
- Consistent use of the Jamsocket domain for documentation links.
These changes will help users navigate the documentation more easily and understand the relationship between Y-Sweet and Jamsocket.
🧰 Tools
🪛 Markdownlint
34-34: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
35-35: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
36-36: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
No description provided.