Thanks to visit codestin.com
Credit goes to github.com

Skip to content

fix(docs): correct markdown links and typo's in REST API page #2479

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Oct 6, 2025
Merged

fix(docs): correct markdown links and typo's in REST API page #2479

merged 2 commits into from
Oct 6, 2025

Conversation

@Priyanshuthapliyal2005
Copy link
Contributor

@Priyanshuthapliyal2005 Priyanshuthapliyal2005 commented Oct 4, 2025 •
edited by coderabbitai bot
Loading

What does this PR do?

This PR fixes:

  • Informal wording in headers section (Would usually be → Typically set to).
image
  • Grammar issue in introduction (without the needing → without needing).
image
  • Incorrect markdown link syntax in Files upload endpoints ([Create File] (/...) → Create File).
image

Test Plan

Verified that all updated links render correctly and text changes improve readability.

Related PRs and Issues

#2478

Have you read the Contributing Guidelines on issues?

Yes

Summary by CodeRabbit

  • Documentation
    • Refined REST API wording for clarity and correctness (e.g., “without needing an SDK” → “needing an SDK”).
    • Clarified header guidance (e.g., “Content-Type” now described as “Typically set to”).
    • Added explicit links to Appwrite SDKs across examples, including chunked uploads guidance.
    • Improved consistency and phrasing across REST intro and headers.
    • Fixed minor typo in REST API card description.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 4, 2025 •
edited
Loading

Walkthrough

  • src/routes/docs/+page.svelte: Corrected a minor typo in the REST API card description (“the needing” → “needing”).
  • src/routes/docs/apis/rest/+page.markdoc: Updated wording for clarity, refined Content-Type header phrasing, replaced some relative links with absolute URLs (e.g., Create File, Create Deployment), added explicit references and links to Appwrite SDKs (including in chunked uploads), and adjusted formatting in tables.
  • No changes to exported/public entities or imports.

Possibly related issues

Suggested reviewers

  • eldadfux
  • tessamero

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The title clearly summarizes the primary changes by indicating updates to markdown links and typographical fixes within the REST API page, which aligns directly with the documented modifications.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c8377b6 and 66f8d99.

📒 Files selected for processing (1)
  • src/routes/docs/apis/rest/+page.markdoc (3 hunks)
🔇 Additional comments (3)
src/routes/docs/apis/rest/+page.markdoc (3)

7-7: LGTM! Grammar correction improves readability.

The removal of "the" before "needing" is the correct grammar fix. "Without needing an SDK" is the proper phrasing.

24-24: LGTM! More professional and concise wording.

The change from "Would usually be set to" to "Typically set to" improves the documentation by making it more direct and professional.

106-108: LGTM! Helpful SDK documentation links added.

The addition of references to Appwrite SDKs throughout the Files section provides helpful context for users. All Markdown link syntax is correct with proper formatting (no spaces before parentheses).

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.

coderabbitai[bot]
coderabbitai bot reviewed Oct 4, 2025
View reviewed changes
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: 0

🧹 Nitpick comments (1)
src/routes/docs/apis/rest/+page.markdoc (1)

108-108: Consider using relative URLs for consistency.

The markdown link syntax fix is correct (removing the space between ] and (). However, the change introduces absolute URLs (https://appwrite.io/docs/...) while the rest of the file consistently uses relative URLs (e.g., lines 32, 84, 95 use /docs/...).

For consistency with the rest of the file, consider using relative URLs:

-Upload endpoints in Appwrite, such as [Create File](https://appwrite.io/docs/references/cloud/client-web/storage#createFile) and [Create Deployment](https://appwrite.io/docs/references/cloud/server-nodejs/functions#createDeployment), are different from other endpoints. These endpoints take multipart form data instead of JSON data. To implement chunked uploads, you will need to implement the following headers. If you wish, this logic is already available in any of the [Appwrite SDKs](/docs/sdks).
+Upload endpoints in Appwrite, such as [Create File](/docs/references/cloud/client-web/storage#createFile) and [Create Deployment](/docs/references/cloud/server-nodejs/functions#createDeployment), are different from other endpoints. These endpoints take multipart form data instead of JSON data. To implement chunked uploads, you will need to implement the following headers. If you wish, this logic is already available in any of the [Appwrite SDKs](/docs/sdks).
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 49dbda9 and c8377b6.

📒 Files selected for processing (2)
  • src/routes/docs/+page.svelte (1 hunks)
  • src/routes/docs/apis/rest/+page.markdoc (3 hunks)
🔇 Additional comments (4)
src/routes/docs/apis/rest/+page.markdoc (3)

7-7: LGTM! Grammar fix is correct.

The removal of the redundant article "the" improves readability and corrects the grammar.

24-24: LGTM! Wording improvement.

"Typically set to" is more professional and direct than "Would usually be."

106-106: LGTM! Helpful SDK reference added.

Adding the link to Appwrite SDKs provides valuable context for users implementing chunked uploads.

src/routes/docs/+page.svelte (1)

461-461: LGTM! Grammar fix is correct.

The removal of the redundant article "the" corrects the grammar and improves readability.

@Priyanshuthapliyal2005
Copy link
Contributor Author

@atharvadeosthale would love your review here.

@tessamero tessamero merged commit 3126d5c into appwrite:main Oct 6, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@tessamero tessamero tessamero approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@Priyanshuthapliyal2005 @tessamero