I think this looks alright, I have no comments on the code itself, mainly because I don't know kotlin or C# well. I would think adding some comments might be useful.

It depends on the language, but we should at least comment on what the function is supposed to do in a comment.

Originally posted by @gewenyu99 in #196 (comment)

💭 Description

I recommend we add a field in the queries page where we add the inbuilt queries that can be accessed example the $id ,$createdAt because i put it as Document ID it didn't exist so i feel its better we mention that it would be useful

👀 Have you spent some time to check if this issue has been raised before?

• I checked and didn't find similar issue

🏢 Have you read the Code of Conduct?

• I have read the Code of Conduct

💭 Description

1. "Query.orderAsc()" and "Query.orderDesc()" don't match the format for the rest of our docs
2. orderAttributes are no longer a thing

👀 Have you spent some time to check if this issue has been raised before?

• I checked and didn't find similar issue

🏢 Have you read the Code of Conduct?

• I have read the Code of Conduct

The enhancement in the documentation
The official https://appwrite.io/docs documentation source code.
wrapping link text in brackets [ ]
It would look professional by adding Appwrite Docs and then mention link rather than mentioning whole link

Please assign this issue to me

👟 Reproduction steps

• Visit the Svelte example app https://appwrite-todo-with-svelte.vercel.app/#/ as linked here https://appwrite.io/docs/getting-started-for-web.
• Sign up
• Try adding an item

👍 Expected behavior

Should get added as in the React example deployment

👎 Actual Behavior

API throws 401 (invisible to the user unless console is opened)

🎲 Appwrite version

Version 1.1.x

💻 Operating system

Linux

🧱 Your Environment

No response

👀 Have you spent some time to check if this issue has been raised before?

• I checked and didn't find similar issue

🏢 Have you read the Code of Conduct?

• I have read the Code of Conduct

💭 Description

As contributing.md is necessary for a valid repo in hacktoberfest, I want to add this in this repository. Please assign it to me. @brandonroberts

👀 Have you spent some time to check if this issue has been raised before?

• I checked and didn't find similar issue

🏢 Have you read the Code of Conduct?

• I have read the Code of Conduct

For https://appwrite.io/docs/installation page, last part. I suggest adding an example screenshot for running the server for the first time. Like personally I faced this issue, I executed the command but did notice to run the link on the browser.
Like "Manual (using docker-compose.yml)" has a title, running the server should also have

• A separate title
• A screenshot

And yeah, I would love to contribute to this issue.

💭 Description

I wanted to change the docs but I really couldn't run the phtml
anyways if possible please make these changes in the docs

Query.startsWith("name", "Once upon a time")
Query.endsWith("name", "happily ever after.")

The above lines of code do not work with Python SDK when I went to the source file the snippets of code were

    @staticmethod
    def starts_with(attribute, value):
        return Query.add_query(attribute, "startsWith", value)

    @staticmethod
    def ends_with(attribute, value):
        return Query.add_query(attribute, "endsWith", value)

So I made the changes and my updated code was

Query.starts_with("name", "Once upon a time")
Query.ends_with("name", "happily ever after.")

But I'm still getting this error appwrite.exception.AppwriteException: Query method not valid: startsWith

Is this a bug ?

👀 Have you spent some time to check if this issue has been raised before?

• I checked and didn't find similar issue

🏢 Have you read the Code of Conduct?

• I have read the Code of Conduct

If you go to the functions docs under build there is a link called Get Build which is not working.

Issue

The doc pages that are children of the Installation page are really hard to discover. I think several things are to blame:

Causes

1. The installation doc is the only doc that has children.
2. The arrow is really small
3. It's not clear that these child links are actually links to whole other doc pages. (see explanation below)
4. Some of the children (env variables mainly) may not make sense to be under a parent named "Installation"

For cause 3, what I mean is on a lot of doc websites they will have links to header anchors of the current doc page as a child of the link. See example taken from https://flareact.com/docs/data-fetching:

Image

Open view:

Closed view:

Potential solutions

1. Make indicator arrow larger
2. Make children expanded by default (as long as there aren't too many children)
3. Make new category called "Server configuration" or "Server management" which can include details about environment variables, how to use docker, upgrading Appwrite, running in production etc.

Personally I think implementing 1. and 3. will be best. And avoiding this style of child links completely might be a good idea. Users just want to see a list of all the pages so they can find info fast. They don't want to have to remember that a certain doc page is a child of another, etc..

If we can decide on a solution we like I am happy to try and tackle this change.

💭 Description

I want to contribute by translating the docs into Nepali Language.

👀 Have you spent some time to check if this issue has been raised before?

• I checked and didn't find similar issue

🏢 Have you read the Code of Conduct?

• I have read the Code of Conduct

👟 Reproduction steps

When I tried to go through the Appwrite documentation. I found it hard to read at first. There are long paragraphs with a light font style that makes it hard to read.

👍 Expected behavior

It is highly recommended that you add a normal (400) font-weight to docs so it is easy to read for people that might have some visual impairment. There are a few recommendations on this blog.

👎 Actual Behavior

The current font-weight is light (300)

🎲 Appwrite version

Different version (specify in environment)

💻 Operating system

Something else

🧱 Your Environment

NA

👀 Have you spent some time to check if this issue has been raised before?

• I checked and didn't find similar issue

🏢 Have you read the Code of Conduct?

• I have read the Code of Conduct

Hello, I just got to know about this particular service (AppWrite), how is a backend server if I still have to host it on digitalOcean.

💭 Description

in the docs for databases / server when switching to GraphQL the REST endpoints are given, see https://appwrite.io/docs/server/databases?sdk=graphql-default

👀 Have you spent some time to check if this issue has been raised before?

• I checked and didn't find similar issue

🏢 Have you read the Code of Conduct?

• I have read the Code of Conduct

The docs suggest that --save should be included when installing Appwrite SDK in Ruby. However, gem doesn't support that option.

🔖 Feature description

I'm possibly being a bit precious here, but it would be cool to have a search feature within the documentation. It could be a small input box above the Getting Started title in the menu.

🎤 Pitch

I wanted to find something in the docs quickly, and I would have been able to easily do it with the ability to search within the docs. I can easily do this by searching with Google on the URL, but it is an easy feature to implement in most places and improves user experience, so why not?

👀 Have you spent some time to check if this issue has been raised before?

• I checked and didn't find similar issue

🏢 Have you read the Code of Conduct?

• I have read the Code of Conduct

💭 Description

Hello :)
I ran into a problem recently, and I was stuck on it for too long.
I wanted to use the createOAuth2Session method.
I encountered a problem because my client is on localhost and appwrite is on appwrite.mydomain.com. This problem is known and there is a simple solution to solve it (https://appwrite.io/docs/custom-domains).

But unfortunately, this page is not referenced in the documentation of the createOAuth2Session method.
I think adding this error page could really help people to understand what is wrong.

👀 Have you spent some time to check if this issue has been raised before?

• I checked and didn't find similar issue

🏢 Have you read the Code of Conduct?

• I have read the Code of Conduct

💭 Description

The phone authentication needs to be more clear when it comes to integrating SMS providers because some SMS providers are integrated with different credentials than the ones mentioned in the documentation

👀 Have you spent some time to check if this issue has been raised before?

• I checked and didn't find similar issue

🏢 Have you read the Code of Conduct?

• I have read the Code of Conduct

💭 Description

The appwrite guide on authentication includes topics such on creating sessions using different authentication providers but not on how to clear/delete a active session .

👀 Have you spent some time to check if this issue has been raised before?

• I checked and didn't find similar issue

🏢 Have you read the Code of Conduct?

• I have read the Code of Conduct

Introduction

GitHub has recently rolled out a public beta for their issue forms feature. This would allow you to create interactive issue templates and validate them 🤯.

Appwrite currently uses the older issue template format. Your task is to create GitHub issue forms for this repository. Please use Appwrite's issue templates as a reference for this PR.

Tasks summary:

• Fork & clone this repository
• Prepare bug report issue form in .github/ISSUE_TEMPLATE/bug.yaml
• Prepare documentation issue form in .github/ISSUE_TEMPLATE/documentation.yaml
• Prepare feature request issue form in .github/ISSUE_TEMPLATE/feature.yaml
• Push changes to master and test issue forms on your fork
• Submit pull request

If you need any help, reach out to us on our Discord server.

Are you ready to work on this issue? 🤔 Let us know, and we will assign it to you 😊

Happy Appwriting!

💭 Description

Migration from firebase, Account credentials is not clearly explained in docs.

This is form-header
Select a source platform with the project you want to migrate. Learn about which platforms are supported.

There is no sample credentials that i can copy and paste from firebase.

const firebaseConfig = {
  apiKey: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  authDomain: "xxxxxxxxxxxxx.firebaseapp.com",
  databaseURL: "https://xxxxxxxxxxxx-default-rtdb.europe-west1.firebasedatabase.app",
  projectId: "xxxxxxxxxxxx",
  storageBucket: "xxxxxxxxxxx.appspot.com",
  messagingSenderId: "xxxxxxxxxxxx",
  appId: "1:xxxxxxxxxx:web:xxxxxxxxxxxxxxxx",
  measurementId: "G-XXXXXXXXXX"
};

which part or which variables or which lines i have to paste to find correct match that i can pass this form to start migration. Personally i could not find. Tried json format, single lines with \n or comma. And also i think some of them appwrite does not need such as measurementId

There is no detailed explanation in this link unfortunately for the migration from firebase.

👀 Have you spent some time to check if this issue has been raised before?

• I checked and didn't find similar issue

🏢 Have you read the Code of Conduct?

• I have read the Code of Conduct

👟 Reproduction steps

Scroll to footer section and see twitter old logo

👍 Expected behavior

Twitter logo should be changed to X

👎 Actual Behavior

Twitter logo is updated recently and hasnt been updated on the site. I didnt find any issue related to this.

Screenshot

🎲 Appwrite version

Appwrite Cloud

💻 Operating system

Windows

🧱 Your Environment

No response

👀 Have you spent some time to check if this issue has been raised before?

• I checked and didn't find similar issue

🏢 Have you read the Code of Conduct?

• I have read the Code of Conduct

💭 Description

The documentation explains the procedure for implementing magic Url authentication in rather ambiguous terms.

I discussed this here

I'd like to alter the documentation to more accurately capture the use of the createMagicURLSessionfunction.

👀 Have you spent some time to check if this issue has been raised before?

• I checked and didn't find similar issue

🏢 Have you read the Code of Conduct?

• I have read the Code of Conduct

1. The CMD and Powershell examples have an extra double quote at the end
2. The docs reference the old runtime image names

The Getting started for android page is not formatted correctly!

💭 Description

Add a feature to sync the language or SDK preference for code snippets for the entire page.

Take this page for example - I noticed that there are 5 code-snippets, and we can switch the SDK between 4 different options (Web, Flutter, Android, iOS)

But the thing is switching the SDK for one code-snippet won't alter other code-snippets. So, say I am working with the Flutter SDK, then I would have to change the SDK 5 times for this particular page.

Implement a feature to sync the preference across the entire page, if changed at one place.

👀 Have you spent some time to check if this issue has been raised before?

• I checked and didn't find similar issue

🏢 Have you read the Code of Conduct?

• I have read the Code of Conduct

It looks like #140 didn't update the examples for Subscribe to Multiple Channels. Below is one of the examples.

documents.A should now be collections.A.documents.A

final client = Client();
final realtime = Realtime(client);
final subscription = realtime.subscribe(['documents.A', 'files']);

subscription.stream.listen((response) {
    // Callback will be executed on changes for documents A and all files.
    print(response);
})

I'm going to submit a pull request that fixes this shortly.

When looking through the docs: https://appwrite.io/docs/database#querying-documents

I was unable to understand what 'separated by commas' meant, since it was unclear as to which coma was being talked of. The example does help, but there's no explanation about it. I had to look through 2-3 projects that I suspected had this functionality where I would be able to distinguish a logical or and an and.

It would be greatly appreciated if such a vital part of the application docs were absolutely clear. Thanks

💭 Description

I noticed some formatting issues with the README.md file. Can I please be assigned this issue? I'll fix them and submit a PR. The main reason for the issue and PR is that you have a note:

Don't forget to use proper indenting for all code examples. The indenting of the code examples should be independent from the indentation of the surrounding HTML tags.

I'd like to change it to this to take advantage of a new GitHub feature:

Note Don't forget to use proper indenting for all code examples. The indenting of the code examples should be independent from the indentation of the surrounding HTML tags.

👀 Have you spent some time to check if this issue has been raised before?

• I checked and didn't find similar issue

🏢 Have you read the Code of Conduct?

• I have read the Code of Conduct

In the Init your SDK part of the documentation, there's this following code:

import 'package:appwrite/appwrite.dart';

Client client = Client();

client
    .setEndpoint('https://localhost/v1') // Your Appwrite Endpoint
    .setProject('5e8cf4f46b5e8') // Your project ID
    .setSelfSigned(true) // For self signed certificates, only use for development
;

Here, the setSelfSigned ideally should be:
setSelfSigned(status: true)

💭 Description

appwrite/appwrite#4954 (comment)

link for - get() is not working under Login section on Authentication docs.

👀 Have you spent some time to check if this issue has been raised before?

• I checked and didn't find similar issue

🏢 Have you read the Code of Conduct?

• I have read the Code of Conduct

💭 Description

Create Attributes section is missing mentioning of Datetime. Was reverted here and never added again it seems.

👀 Have you spent some time to check if this issue has been raised before?

• I checked and didn't find similar issue

🏢 Have you read the Code of Conduct?

• I have read the Code of Conduct

Service doc pages have headers for things with anchor links:

The env vars page has anchors but not links:

Should be a simple addition.

Markup for env var category headers:

 <h2 id="<?php echo $this->escape(strtolower(str_replace(' ', '_', $category))); ?>"><?php echo $this->escape($category); ?></h2>

Markup for service header links:

<h2 class="margin-bottom">
    <a href="/docs/<?php echo $this->escape($family); ?>/<?php echo $serviceName; ?>#<?php echo $operation['operationId']; ?>" id="<?php echo $operation['operationId']; ?>"><?php echo $this->escape($title); ?></a>
</h2>

🔖 Feature description

Adding Hover Effect to Social Icons and links if available.

Assign this to me!!

🎤 Pitch

Adding Hover Effect helps us to understand that which icon s selected when we hover on them.

👀 Have you spent some time to check if this issue has been raised before?

• I checked and didn't find similar issue

🏢 Have you read the Code of Conduct?

• I have read the Code of Conduct

Issue

Repro:

1. Go to https://appwrite.io/docs/server/storage
2. Click an anchor link (e.g. from this list)

Actual:
Sticky header covers the title.

Expected:
Sticky header should not cover title.

Fix

This can easily be fixed with the scroll-margin-top CSS property. Just add it to all the anchors with a value equal to the actions bar height which seems to be 74px.

More info on scroll-margin-top and how to use it:
https://gomakethings.com/how-to-prevent-anchor-links-from-scrolling-behind-a-sticky-header-with-one-line-of-css/

I'd like to fix this but I'm not sure where the styling is located, or if I can do it all inline. I also would have to verify how this effects mobile layouts and the other responsive layouts.

Under the CRON Syntax in tasks documentation in the website this is given

This sentence seems to have a grammatical error.

The Sentence given is -> The create a new task, you need to supply Appwrite with a valid CRON syntax.

Possible Correction -> To create a new task, you need to supply Appwrite with a valid CRON syntax.

Also found in this

Sentence given -> If you required scheduling a task to be executed for selected days only.

Possible Correction -> If you require scheduling a task to be executed for selected days only.
If the above corrections seems appropriate I would like to fix it in the docs.

👟 Reproduction steps

Go to https://appwrite.io/docs/client/account?sdk=web-default. There you will find a dropdown.

👍 Expected behavior

The dropdown overlay should come beneath the dropdown field. Also page-scroll should be enabled and the dropdown should close whenever user scrolls the page.

👎 Actual Behavior

Dropdown overlay overlaps the dropdown field.
Unable to scroll the page if dropdown is open.

🎲 Appwrite version

Version 1.0.x

💻 Operating system

MacOS

🧱 Your Environment

No response

👀 Have you spent some time to check if this issue has been raised before?

• I checked and didn't find similar issue

🏢 Have you read the Code of Conduct?

• I have read the Code of Conduct

🔖 Feature description

The documentation website should be dynamic to set the theme to default system theme.
That is if the user system theme is dark , docs webstie should be dark and vice versa.

🎤 Pitch

I feel like this would be better for the website because most people prefer dark themes and by default the theme is set to light,
People can still toggle from dark to light using the toggle button. But this would be a cool feature.

👀 Have you spent some time to check if this issue has been raised before?

• I checked and didn't find similar issue

🏢 Have you read the Code of Conduct?

• I have read the Code of Conduct

💭 Description

add a repository stats like how many issues are open ,how many are closed , no of contributors , same for pr's and languages used.. etc in a attractive way

👀 Have you spent some time to check if this issue has been raised before?

• I checked and didn't find similar issue

🏢 Have you read the Code of Conduct?

• I have read the Code of Conduct

💭 Description

Add Hostinger here:
https://appwrite.io/docs/custom-domains#addCNAME

I’d be happy to add if assigned.

👀 Have you spent some time to check if this issue has been raised before?

• I checked and didn't find similar issue

🏢 Have you read the Code of Conduct?

• I have read the Code of Conduct

🔖 Feature description

Currently, we have to manually change the language to the one required on 'each' code snippet on some documentation pages. It'd be time saver if any language change is reflected to all the code snippets on the current page.

Pages that I've seen have issues:

• https://appwrite.io/docs/command-line
• https://appwrite.io/docs/realtime
• https://appwrite.io/docs/databases
• https://appwrite.io/docs/storage
• https://appwrite.io/docs/authentication

Discord message for the same: https://discord.com/channels/564160730845151244/870534256324124692/1088733426678517790

🎤 Pitch

Selecting say Apple for one section should change all example with swift snippets on the whole page.
The Reference docs handle this by allowing to choose the required option from the dropdown at the top of the documentation (X integration with [dropdown here], where X is either a Client or Server.)

👀 Have you spent some time to check if this issue has been raised before?

• I checked and didn't find similar issue

🏢 Have you read the Code of Conduct?

• I have read the Code of Conduct