diff --git a/docs/README.md b/docs/README.md index b07b56b89..6d3f92636 100644 --- a/docs/README.md +++ b/docs/README.md @@ -13,7 +13,6 @@ changes in a few minutes after your pull request is merged. ## Running locally - The above workflow is great since it doesn't require you to setup anything on your local machine. But if you plan on contributing frequently, you might find it easier to run things locally. diff --git a/docs/docs/.vitepress/config.ts b/docs/docs/.vitepress/config.ts index bc2b77fca..4914ab625 100644 --- a/docs/docs/.vitepress/config.ts +++ b/docs/docs/.vitepress/config.ts @@ -7,7 +7,7 @@ export default defineConfig({ description: "Documentation and help for Ente's products", head: [["link", { rel: "icon", type: "image/png", href: "/favicon.png" }]], cleanUrls: true, - ignoreDeadLinks: 'localhostLinks', + ignoreDeadLinks: "localhostLinks", themeConfig: { // We use the default theme (with some CSS color overrides). This // themeConfig block can be used to further customize the default theme. diff --git a/docs/docs/.vitepress/sidebar.ts b/docs/docs/.vitepress/sidebar.ts index eac60e9f1..ce6c11b8b 100644 --- a/docs/docs/.vitepress/sidebar.ts +++ b/docs/docs/.vitepress/sidebar.ts @@ -84,8 +84,14 @@ export const sidebar = [ text: "Guides", items: [ { text: "Introduction", link: "/self-hosting/guides/" }, - { text: "Configure custom server", link: "/self-hosting/guides/custom-server/" }, - { text: "Mobile build", link: "/self-hosting/guides/mobile-build" }, + { + text: "Configure custom server", + link: "/self-hosting/guides/custom-server/", + }, + { + text: "Mobile build", + link: "/self-hosting/guides/mobile-build", + }, { text: "System requirements", link: "/self-hosting/guides/system-requirements", diff --git a/docs/docs/about/index.md b/docs/docs/about/index.md index 27a0b4bb9..8cffbe048 100644 --- a/docs/docs/about/index.md +++ b/docs/docs/about/index.md @@ -11,9 +11,9 @@ Ente is a end-to-end encrypted platform for privately, reliably, and securely storing your data on the cloud. On top of this platform, Ente offers two products: -* **Ente Photos** - An alternative to Google Photos and Apple Photos +- **Ente Photos** - An alternative to Google Photos and Apple Photos -* **Ente Auth** - A free 2FA alternative to Authy +- **Ente Auth** - A free 2FA alternative to Authy Both these apps are available for all desktop (Linux, Mac, Windows) and mobile (Android, iOS and F-Droid) platforms. They also work directly in your web @@ -60,8 +60,8 @@ how we're building Ente, you can read our [blog](https://ente.io/blog) (or subscribe to it via [RSS](https://ente.io/blog/rss.xml)) To suggest new features and/or offer your perspective on how we should design -planned and upcoming features, use our [GitHub -discussions](https://github.com/ente-io/ente/discussions) +planned and upcoming features, use our +[GitHub discussions](https://github.com/ente-io/ente/discussions) Or if you'd just like to hang out, join our [Discord](https://discord.gg/z2YVKkycX3), follow us on diff --git a/docs/docs/auth/migration-guides/index.md b/docs/docs/auth/migration-guides/index.md index 23288a695..603c87011 100644 --- a/docs/docs/auth/migration-guides/index.md +++ b/docs/docs/auth/migration-guides/index.md @@ -1,6 +1,8 @@ --- title: Migrating to Ente Auth -description: Guides for migrating your existing 2FA tokens from other products into Ente Auth +description: + Guides for migrating your existing 2FA tokens from other products into Ente + Auth --- # Migrating to Ente Auth diff --git a/docs/docs/index.md b/docs/docs/index.md index 0f9a84497..af5fd2cdd 100644 --- a/docs/docs/index.md +++ b/docs/docs/index.md @@ -4,9 +4,8 @@ title: Home # Welcome! -This site contains documentation and help for Ente Photos and Ente Auth. -It describes various features, and also offers various troubleshooting -suggestions. +This site contains documentation and help for Ente Photos and Ente Auth. It +describes various features, and also offers various troubleshooting suggestions. Use the **sidebar** menu to navigate to information about the product (Photos or Auth) you'd like to know more about. Or use the **search** at the top to try and diff --git a/docs/docs/photos/features/cast/index.md b/docs/docs/photos/features/cast/index.md index ad52f2758..89dc801f6 100644 --- a/docs/docs/photos/features/cast/index.md +++ b/docs/docs/photos/features/cast/index.md @@ -39,11 +39,11 @@ Chromecast TVs or other Internet-connected large screen devices. On Google Chrome and other Chromium browsers, you will see a button labeled - "Auto Pair". This option will prompt you to select a Chromecast supported device - on your local network. Note: this option requires connecting to Google servers - to load necessary dependencies. This option does not transmit any sensitive data - through Google servers, such as your photos. Once your Chromecast device is - connected, you're all set. + "Auto Pair". This option will prompt you to select a Chromecast supported + device on your local network. Note: this option requires connecting to + Google servers to load necessary dependencies. This option does not transmit + any sensitive data through Google servers, such as your photos. Once your + Chromecast device is connected, you're all set. On all browsers, you'll see the option to "Pair with PIN". This option works with all devices, Chromecast-enabled or not. You'll be required to load up diff --git a/docs/docs/photos/features/family-plans.md b/docs/docs/photos/features/family-plans.md index 5a93ffb81..8405c7dcf 100644 --- a/docs/docs/photos/features/family-plans.md +++ b/docs/docs/photos/features/family-plans.md @@ -1,6 +1,7 @@ --- title: Family plans -description: Share your Ente Photos plan with your family members with no extra cost +description: + Share your Ente Photos plan with your family members with no extra cost --- # Family plans diff --git a/docs/docs/photos/features/public-links.md b/docs/docs/photos/features/public-links.md index edfe152ac..7f079b82f 100644 --- a/docs/docs/photos/features/public-links.md +++ b/docs/docs/photos/features/public-links.md @@ -1,6 +1,8 @@ --- title: Public links -description: Share photos with your friends and family without them needing to install Ente Photos +description: + Share photos with your friends and family without them needing to install + Ente Photos --- # Public Links diff --git a/docs/docs/photos/features/referrals.md b/docs/docs/photos/features/referrals.md index 71a23e82d..085a0b19b 100644 --- a/docs/docs/photos/features/referrals.md +++ b/docs/docs/photos/features/referrals.md @@ -1,6 +1,8 @@ --- title: Referral plan -description: Earn and expand your storage by referring Ente Photos to your friends and family +description: + Earn and expand your storage by referring Ente Photos to your friends and + family --- # Referral plan diff --git a/docs/docs/photos/features/sharing.md b/docs/docs/photos/features/sharing.md index 9d023e78d..9f32830ec 100644 --- a/docs/docs/photos/features/sharing.md +++ b/docs/docs/photos/features/sharing.md @@ -1,6 +1,7 @@ --- title: Sharing -description: Ente allows you to share albums and collaborate with your loved ones +description: + Ente allows you to share albums and collaborate with your loved ones --- # Sharing @@ -36,4 +37,5 @@ same album - someone can be added as a `Collaborator`, while someone else as a If you wish to collect photos from folks who are not Ente, you can do so with our Links. Simply tick the box that says "Allow uploads", and anyone who has -access to the link will be able to add photos to your album. [Read more](https://ente.io/blog/collect-photos/) +access to the link will be able to add photos to your album. +[Read more](https://ente.io/blog/collect-photos/) diff --git a/docs/docs/photos/troubleshooting/files-not-uploading.md b/docs/docs/photos/troubleshooting/files-not-uploading.md index 45ab86e8c..82c8bced0 100644 --- a/docs/docs/photos/troubleshooting/files-not-uploading.md +++ b/docs/docs/photos/troubleshooting/files-not-uploading.md @@ -1,6 +1,7 @@ --- title: Files not uploading -description: Troubleshooting when files are not uploading from your Ente Photos app +description: + Troubleshooting when files are not uploading from your Ente Photos app --- # Files not uploading diff --git a/docs/docs/self-hosting/faq/otp.md b/docs/docs/self-hosting/faq/otp.md index 8cdbb169e..c3356b7bc 100644 --- a/docs/docs/self-hosting/faq/otp.md +++ b/docs/docs/self-hosting/faq/otp.md @@ -8,9 +8,9 @@ description: Getting the OTP for a self host Ente The self-hosted Ente by default does not send out emails, so you can pick the verification code by: -* Getting it from the server logs, or +- Getting it from the server logs, or -* Reading it from the DB (otts table) +- Reading it from the DB (otts table) You can also set pre-defined hardcoded OTTs for certain users when running locally by creating a `museum.yaml` and adding the `internal.hardcoded-ott` diff --git a/docs/docs/self-hosting/guides/mobile-build.md b/docs/docs/self-hosting/guides/mobile-build.md index 00b353acd..597f27db1 100644 --- a/docs/docs/self-hosting/guides/mobile-build.md +++ b/docs/docs/self-hosting/guides/mobile-build.md @@ -1,13 +1,15 @@ --- title: Building mobile apps -description: Connecting to your custom self-hosted server when building the Ente mobile apps from source +description: + Connecting to your custom self-hosted server when building the Ente mobile + apps from source --- # Mobile: Build and connect to self-hosted server -The up to date instructions to build the mobile apps are in the [Ente -Photos](https://github.com/ente-io/ente/tree/main/mobile#readme) and [Ente -Auth](https://github.com/ente-io/ente/tree/main/auth#readme) READMEs. When +The up to date instructions to build the mobile apps are in the +[Ente Photos](https://github.com/ente-io/ente/tree/main/mobile#readme) and +[Ente Auth](https://github.com/ente-io/ente/tree/main/auth#readme) READMEs. When building or running, you can use the ```sh diff --git a/docs/docs/self-hosting/guides/system-requirements.md b/docs/docs/self-hosting/guides/system-requirements.md index d59df1c47..55eb9e9e3 100644 --- a/docs/docs/self-hosting/guides/system-requirements.md +++ b/docs/docs/self-hosting/guides/system-requirements.md @@ -10,5 +10,5 @@ very light weight - it's just a single go binary, and it doesn't do any server side ML, so I feel it should be able to run on anything reasonable. We've used the server quite easily on small cloud instances, old laptops etc. A -community member also reported being able to run the server on [very low-end -embedded devices](https://github.com/ente-io/ente/discussions/594). +community member also reported being able to run the server on +[very low-end embedded devices](https://github.com/ente-io/ente/discussions/594). diff --git a/docs/docs/self-hosting/index.md b/docs/docs/self-hosting/index.md index 3092830f8..b659c4061 100644 --- a/docs/docs/self-hosting/index.md +++ b/docs/docs/self-hosting/index.md @@ -10,9 +10,9 @@ the same code we use for our own cloud service. > [!TIP] > -> To get some context, you might find our [blog -> post](https://ente.io/blog/open-sourcing-our-server/) announcing the open -> sourcing of our server useful. +> To get some context, you might find our +> [blog post](https://ente.io/blog/open-sourcing-our-server/) announcing the +> open sourcing of our server useful. ## Getting started @@ -39,24 +39,24 @@ will be connecting to the server running on your local machine at localhost:8080. For the mobile apps, you don't even need to build, and can install normal Ente -apps and configure them to use your [custom self-hosted -server](guides/custom-server). +apps and configure them to use your +[custom self-hosted server](guides/custom-server). > If you want to build from source, see the instructions -[here](guides/mobile-build). +> [here](guides/mobile-build). ## Next steps -* More details about the server are in its - [README](https://github.com/ente-io/ente/tree/main/server#readme) +- More details about the server are in its + [README](https://github.com/ente-io/ente/tree/main/server#readme) -* More details about running the server (with or without Docker) are in - [RUNNING](https://github.com/ente-io/ente/blob/main/server/RUNNING.md) +- More details about running the server (with or without Docker) are in + [RUNNING](https://github.com/ente-io/ente/blob/main/server/RUNNING.md) -* If you have questions around self-hosting that are not answered in any of the - existing documentation, you can ask in our [GitHub - Discussions](https://github.com/ente-io/ente/discussions). **Please remember - to search first if the query has been already asked and answered.** +- If you have questions around self-hosting that are not answered in any of + the existing documentation, you can ask in our + [GitHub Discussions](https://github.com/ente-io/ente/discussions). **Please + remember to search first if the query has been already asked and answered.** ## Contributing! diff --git a/docs/docs/self-hosting/troubleshooting/yarn.md b/docs/docs/self-hosting/troubleshooting/yarn.md index d117d9c3c..7d8d13b00 100644 --- a/docs/docs/self-hosting/troubleshooting/yarn.md +++ b/docs/docs/self-hosting/troubleshooting/yarn.md @@ -7,4 +7,4 @@ description: Fixing yarn install errors when trying to self host Ente If your `yarn install` is failing, make sure you are using Yarn Classic -* https://classic.yarnpkg.com/lang/en/docs/install +- https://classic.yarnpkg.com/lang/en/docs/install