-
Notifications
You must be signed in to change notification settings - Fork 327
Bifurcate Advanced > Platform docs into other relevant sections #3038
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
Open
adityaoberai
wants to merge
10
commits into
main
Choose a base branch
from
bifurcate-platforms-docs
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 3 commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
d96ebb4
Bifurcate Advanced > Platform docs into other relevant sections
adityaoberai 3cafd25
Shift Roles docs to Advanced > Security
adityaoberai b70e8d6
Merge branch 'main' into bifurcate-platforms-docs
adityaoberai 5f2c043
Restructure APIs docs and apply PR review feedback
adityaoberai b9e60ff
Merge branch 'main' into bifurcate-platforms-docs
adityaoberai 475e7af
APIs docs overview page + layout update
adityaoberai b16455f
Remove outdated notes
adityaoberai 381e31b
Improve API docs overview structuring
adityaoberai dc5bb92
Add new VCS variables
adityaoberai c6df96b
Format env var tables
atharvadeosthale File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,61 @@ | ||
| <script lang="ts"> | ||
| import Docs from '$lib/layouts/Docs.svelte'; | ||
| import Sidebar, { type NavParent, type NavTree } from '$lib/layouts/Sidebar.svelte'; | ||
|
|
||
| const parent: NavParent = { | ||
| href: '/docs', | ||
| label: 'API integration' | ||
| }; | ||
|
|
||
| const navigation: NavTree = [ | ||
| { | ||
| label: 'Getting started', | ||
| items: [ | ||
| { | ||
| label: 'Overview', | ||
| href: '/docs/advanced/api-integration' | ||
| } | ||
| ] | ||
| }, | ||
| { | ||
| label: 'Events and webhooks', | ||
| items: [ | ||
| { | ||
| label: 'Events', | ||
| href: '/docs/advanced/api-integration/events' | ||
| }, | ||
| { | ||
| label: 'Webhooks', | ||
| href: '/docs/advanced/api-integration/webhooks' | ||
| } | ||
| ] | ||
| }, | ||
| { | ||
| label: 'Error reference', | ||
| items: [ | ||
| { | ||
| label: 'Response codes', | ||
| href: '/docs/advanced/api-integration/response-codes' | ||
| }, | ||
| { | ||
| label: 'Error handling', | ||
| href: '/docs/advanced/api-integration/error-handling' | ||
| } | ||
| ] | ||
| }, | ||
| { | ||
| label: 'Policies', | ||
| items: [ | ||
| { | ||
| label: 'Release policy', | ||
| href: '/docs/advanced/api-integration/release-policy' | ||
| } | ||
| ] | ||
| } | ||
| ]; | ||
| </script> | ||
|
|
||
| <Docs variant="two-side-navs"> | ||
| <Sidebar {navigation} {parent} /> | ||
| <slot /> | ||
| </Docs> | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| --- | ||
| layout: article | ||
| title: API integration | ||
| description: Integrate Appwrite with your apps using events and webhooks, and learn how Appwrite's APIs report response codes and errors. | ||
| --- | ||
|
|
||
| Appwrite is designed to integrate with both your frontend and backend apps. Learn how to react to platform events, keep external systems in sync with webhooks, and handle the response codes and errors returned by Appwrite's APIs. | ||
|
|
||
| # Events and webhooks {% #events-and-webhooks %} | ||
|
|
||
| React to events that occur across your Appwrite project and notify external systems. | ||
|
|
||
| {% cards %} | ||
| {% cards_item href="/docs/advanced/api-integration/events" title="Events" %} | ||
| Appwrite allows you to react to events that occur on the platform. | ||
| {% /cards_item %} | ||
|
|
||
| {% cards_item href="/docs/advanced/api-integration/webhooks" title="Webhooks" %} | ||
| Use webhooks to update backend integrations about Appwrite events. | ||
| {% /cards_item %} | ||
| {% /cards %} | ||
|
|
||
| # Error reference {% #error-reference %} | ||
|
|
||
| Understand how Appwrite's APIs report success and failure, and how to handle errors gracefully. | ||
|
|
||
| {% cards %} | ||
| {% cards_item href="/docs/advanced/api-integration/response-codes" title="Response codes" %} | ||
| Learn about response codes and errors returned by Appwrite APIs. | ||
| {% /cards_item %} | ||
|
|
||
| {% cards_item href="/docs/advanced/api-integration/error-handling" title="Error handling" %} | ||
| Best practices for handling Appwrite errors in your applications. | ||
| {% /cards_item %} | ||
| {% /cards %} | ||
|
|
||
| # Policies {% #policies %} | ||
|
|
||
| {% cards %} | ||
| {% cards_item href="/docs/advanced/api-integration/release-policy" title="Release policy" %} | ||
| Understand how Appwrite releases and versions its platforms and APIs. | ||
| {% /cards_item %} | ||
| {% /cards %} |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
I feel like this page could be a container for simply just
APIsand we can drop the integration part. Maybe have some overview of the different APIs types Appwrite support and why we offer different types. We can still link to the different API types directly from the main navigation like we do now.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.
We can even use the existing
/docs/apispath.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.
I had thought about that but right now the APIs section is structured to contain info on the different protocols.
This broadens the scope of the section. If that is alright, I can directly shift these there.
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.
I think we can, it really make sense the more I look at the content. We can have a sub category for protocols and around them all the common things like response models or events, links structure will also work really well this way.
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.
I've gotten a version of this ready, need a review