Replies: 10 comments 35 replies
-
|
Search. |
Beta Was this translation helpful? Give feedback.
-
|
s a m e |
Beta Was this translation helpful? Give feedback.
-
|
A better layout for the different endpoints in an API. For example, if I go to the Database API server-side docs and click on something that's really close to the end on the page, I have to scroll all the way back up to look for the other endpoints. Not sure what could be a better layout though 😅 |
Beta Was this translation helpful? Give feedback.
-
|
We actually do have this, but I still think it can be better. |
Beta Was this translation helpful? Give feedback.
-
|
I've never used that button or noticed it XD |
Beta Was this translation helpful? Give feedback.
-
|
where is the current docs website repo? |
Beta Was this translation helpful? Give feedback.
-
|
|
Beta Was this translation helpful? Give feedback.
-
|
|
Beta Was this translation helpful? Give feedback.
-
|
References & APIs list. |
Beta Was this translation helpful? Give feedback.
-
|
Pretty cool, I liked the Vue one the most! |
Beta Was this translation helpful? Give feedback.
-
|
I tried to redesign the Appwrite docs earlier but due to college stuffs couldn't make it. But here's what I came out at that point during the research phase. Hope this will help you to make Appwrite docs better in the next version. Link to Figma file(representing pain points):- https://www.figma.com/file/rjgUeRP3fn8YqhKE8h0FN2/Appwrite-Docs-Redesign?type=design&node-id=10%3A6060&t=pSyPjhMRyvUQ8Y0C-1 Link to redesign attempt file:- https://www.figma.com/file/rjgUeRP3fn8YqhKE8h0FN2/Appwrite-Docs-Redesign?type=design&node-id=0%3A1&t=pSyPjhMRyvUQ8Y0C-1 Also, in addition to the above, I'd like to add live working examples for each API or functions(if possible) |
Beta Was this translation helpful? Give feedback.
-
|
O wow that's amazing. Maybe you can try working on this during Hacktoberfest this year, if we participate again. We always wanted to include designers in the OSS world! |
Beta Was this translation helpful? Give feedback.
-
|
The live examples thing is definitely something I want to see, too! |
Beta Was this translation helpful? Give feedback.
-
|
Thank you @gewenyu99 Hope these ideas would help to make better docs. Meanwhile I'm a developer by passion and designer by hobby. 😄 |
Beta Was this translation helpful? Give feedback.
-
|
Playground on every endpoint, probably you can create a base app, hidden of public, but that you can edit and hit to see the expected results. Probably a lot of work due to the amount of SDKs. |
Beta Was this translation helpful? Give feedback.
-
|
👍 I personally want to do this with Web at the very least, if we get time :P I believe this will be mostly good enough. The behavior across our SDKs are very consistent. Playground for Apple, for example, might be much harder. Do you know of some other services that have this in docs? I want to peep to see what/how they do this. |
Beta Was this translation helpful? Give feedback.
-
|
A recipes section with examples like, authentication, pagination, search, upload, validation with functions, etc |
Beta Was this translation helpful? Give feedback.
-
|
How do you feel about something with a similar purpose, like a implementation steps section for each service. It would walk through the steps you take to add a service to your app. I think this kind of high level information is 100% direly missing from our docs. |
Beta Was this translation helpful? Give feedback.
-
|
Yeah is kind of that, the idea is to include things like we always have to do, for example, in pagination we can use offset and cursor. Currently, we have both examples, but they're not complete as isn't the intention of the documentation at the moment. The receipt should cover things like infinite pagination, previous, next buttons, etc. In other words completelly functional code |
Beta Was this translation helpful? Give feedback.
-
Do you have examples of how others do this? I can take inspiration ;) |
Beta Was this translation helpful? Give feedback.
-
|
Sure, I like this two examples: https://mantine.dev/form/recipes/ I like the mantine docs, specially that code is in the center, it make feel like it's important and I have to focus on it, in appwrite now I'm used to docs, but at the beginning the experience wasn't so good because the code is at the right. I'd move the code after the params description |
Beta Was this translation helpful? Give feedback.
-
|
Thank you! I'll take a look <3 |
Beta Was this translation helpful? Give feedback.
-
|
I know the website is probably not gonna get Implemented it in Next.js / React. But, I would like to do a lot of contributions if implemented in Next.js / React |
Beta Was this translation helpful? Give feedback.
-
|
It's probably going to be Markdown with JS/HTML mixins, and can be built easily for contributors. That's one of the big issues we're trying to solve, is maintainability, especially for people outside our team <3 |
Beta Was this translation helpful? Give feedback.
-
|
Does this involve static site generators? |
Beta Was this translation helpful? Give feedback.
-
|
Check out this personal blog page of Josh Comeau https://www.joshwcomeau.com/react/why-react-re-renders/ It's written in Mdx.js (MarkDown with TypeScript JSX) with React. You can add JSX component right into Markdown. Its an awesome library to create interactable Markdown Websites |
Beta Was this translation helpful? Give feedback.
-
We might do MDX, or something similar. Probably not react, since console is written in svelte, we have no reason to tack on a new framework. Anyway, we'll figure something out :P |
Beta Was this translation helpful? Give feedback.
-
|
A copy-pastable example for REST api using |
Beta Was this translation helpful? Give feedback.
-
|
note that when sending requests, sending session cookie works fine. You do not necessarily need to request for jwt before requesting any endpoint. That Postman collection works great. You just need to update the api endpoint variable to the new appwrite api enpoint url |
Beta Was this translation helpful? Give feedback.
-
|
We almost did this, actually. But it's almost impossible to do chunked uploads the way we implmented them with curl. In fact I think we generated cURL examples in our SDK generators but never exposed them 😆 We can try to look into this, but keep in mind the experience is going to be terrible with session management and all :P |
Beta Was this translation helpful? Give feedback.
-
|
Ahh. I think the playground idea above makes more sense. |
Beta Was this translation helpful? Give feedback.
-
|
You can got it from https://github.com/appwrite/appwrite/tree/master/app/config/specs |
Beta Was this translation helpful? Give feedback.
-
|
Play ground would be nice. Maybe shell projects with prepopulated data you can clone to follow tutorials with, too? |
Beta Was this translation helpful? Give feedback.
-
|
Beta Was this translation helpful? Give feedback.
-
|
If you have to pick one from this list, what would it be. |
Beta Was this translation helpful? Give feedback.
-
|
Beta Was this translation helpful? Give feedback.
-
|
This already exists ;) we'd just package this into our docs. https://github.com/open-runtimes/open-runtimes/blob/main/docs/add-runtime.md What's your next item. |
Beta Was this translation helpful? Give feedback.
-
|
Know cause we use it to create our own runtime, but it's not very beginner friendly :) |
Beta Was this translation helpful? Give feedback.
-
|
It probably will not be available for Cloud, just because it would be our infrastructure, we'll see what we can do for self-hosting. Creating your own runtime in general will be tricky to do :P Thanks for the suggestion! |
Beta Was this translation helpful? Give feedback.
-
|
Spoon feeding to the new users by helping them how they can create themselves. |
Beta Was this translation helpful? Give feedback.
-
|
New appwrite docs will have chocolate and vanilla rice pudding. I'll try to spoon feed as many as I can! |
Beta Was this translation helpful? Give feedback.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
-
Hi all!
We're working on the next generation of Appwrite's docs to address some of the pain points and limitations we currently face.
This is your chance to voice your wildest wishes about Appwrite's docs. You can ask for one (1) item, so make it count!
Please avoid duplicating wishes that others have already made, but feel free to upvote them!
We'll be taking these wishes into account when we implement our update.
Cheers,
Vincent
Beta Was this translation helpful? Give feedback.
All reactions