Quellcode durchsuchen

[docs] Prepare for first publish (#735)

Finalize the structure of the docs, and go through all of the existing
content, cleaning it up and making it a bit more consistent.

Apart from the photos/troubleshooting/sharing-logs page, there are no
other placeholders left. The content is still not complete, but things
are at a state where we can publish this and then iteratively keep
adding to it.
Manav Rathi vor 1 Jahr
Ursprung
Commit
457b1c1abd
40 geänderte Dateien mit 551 neuen und 395 gelöschten Zeilen
  1. 0 4
      docs/docs/.vitepress/config.ts
  2. 84 17
      docs/docs/.vitepress/sidebar.ts
  3. 15 0
      docs/docs/about/contribute.md
  4. 29 82
      docs/docs/about/index.md
  5. 6 6
      docs/docs/auth/index.md
  6. 9 0
      docs/docs/auth/migration-guides/index.md
  7. 0 8
      docs/docs/auth/support/contribute.md
  8. 2 2
      docs/docs/de/auth/index.md
  9. 16 0
      docs/docs/index.md
  10. 0 0
      docs/docs/photos/faq/faq.md
  11. 9 0
      docs/docs/photos/faq/index.md
  12. 41 27
      docs/docs/photos/features/albums.md
  13. 16 9
      docs/docs/photos/features/archive.md
  14. 0 36
      docs/docs/photos/features/cast.md
  15. 65 0
      docs/docs/photos/features/cast/index.md
  16. 0 0
      docs/docs/photos/features/cast/tv-pairing-screen.webp
  17. 0 0
      docs/docs/photos/features/cast/web-pairing-options.webp
  18. 0 0
      docs/docs/photos/features/cast/web-play-album-on-tv.webp
  19. 17 12
      docs/docs/photos/features/collect.md
  20. 6 1
      docs/docs/photos/features/family-plans.md
  21. 27 20
      docs/docs/photos/features/hide.md
  22. 0 0
      docs/docs/photos/features/live-photos.md
  23. 43 0
      docs/docs/photos/features/location-tags.md
  24. 0 35
      docs/docs/photos/features/location.md
  25. 27 22
      docs/docs/photos/features/map.md
  26. 5 0
      docs/docs/photos/features/public-links.md
  27. 15 5
      docs/docs/photos/features/quick-link.md
  28. 20 15
      docs/docs/photos/features/referrals.md
  29. 8 3
      docs/docs/photos/features/trash.md
  30. 14 8
      docs/docs/photos/features/uncategorized.md
  31. 20 14
      docs/docs/photos/features/watch-folder.md
  32. 0 0
      docs/docs/photos/getting-started/index.md
  33. 14 38
      docs/docs/photos/index.md
  34. 0 0
      docs/docs/photos/misc/contributors.md
  35. 12 6
      docs/docs/photos/troubleshooting/files-not-uploading.md
  36. 0 15
      docs/docs/photos/troubleshooting/report-bug.md
  37. 26 0
      docs/docs/photos/troubleshooting/sharing-logs.md
  38. 0 5
      docs/docs/photos/troubleshooting/video-not-playing.md
  39. 1 1
      docs/package.json
  40. 4 4
      docs/yarn.lock

+ 0 - 4
docs/docs/.vitepress/config.ts

@@ -18,10 +18,6 @@ export default defineConfig({
             pattern:
                 "https://github.com/ente-io/ente/edit/main/docs/docs/:path",
         },
-        // nav: [
-        //     { text: "Photos", link: "/photos/index" },
-        //     { text: "Authenticator", link: "/authenticator/index" },
-        // ],
         search: {
             provider: "local",
             options: {

+ 84 - 17
docs/docs/.vitepress/sidebar.ts

@@ -1,27 +1,94 @@
-// When adding new pages, they need to manually inserted into their appropriate
-// place here if you wish them to also appear in the sidebar.
+// When adding new pages, they need to be manually inserted into their
+// appropriate place here.
 
-export const sidebar = [];
+export const sidebar = [
+    {
+        text: "Photos",
+        items: [
+            { text: "Introduction", link: "/photos/" },
+            {
+                text: "Features",
+                collapsed: true,
+                items: [
+                    { text: "Albums", link: "/photos/features/albums" },
+                    { text: "Archiving", link: "/photos/features/archive" },
+                    { text: "Cast", link: "/photos/features/cast/" },
+                    {
+                        text: "Collecting photos",
+                        link: "/photos/features/collect",
+                    },
+                    {
+                        text: "Family plans",
+                        link: "/photos/features/family-plans",
+                    },
+                    { text: "Hidden photos", link: "/photos/features/hide" },
+                    {
+                        text: "Location tags",
+                        link: "/photos/features/location-tags",
+                    },
+                    { text: "Map", link: "/photos/features/map" },
+                    {
+                        text: "Public link",
+                        link: "/photos/features/public-link",
+                    },
+                    { text: "Quick link", link: "/photos/features/quick-link" },
+                    { text: "Referrals", link: "/photos/features/referrals" },
+                    { text: "Trash", link: "/photos/features/trash" },
+                    {
+                        text: "Uncategorized",
+                        link: "/photos/features/uncategorized",
+                    },
+                    {
+                        text: "Watch folder",
+                        link: "/photos/features/watch-folder",
+                    },
+                ],
+            },
+            { text: "FAQ", link: "/photos/faq/" },
+            {
+                text: "Troubleshooting",
+                collapsed: true,
+                items: [
+                    {
+                        text: "Files not uploading",
+                        link: "/photos/troubleshooting/files-not-uploading",
+                    },
+                    {
+                        text: "Sharing debug logs",
+                        link: "/photos/troubleshooting/sharing-logs",
+                    },
+                ],
+            },
+        ],
+    },
+    {
+        text: "Auth",
+        items: [
+            { text: "Introduction", link: "/auth/" },
+            {
+                text: "Migration guides",
+                collapsed: true,
+                items: [
+                    { text: "Introduction", link: "/auth/migration-guides/" },
+                ],
+            },
+        ],
+    },
+    {
+        text: "About",
+        link: "/about/",
+    },
+    {
+        text: "Contribute",
+        link: "/about/contribute",
+    },
+];
 
 function sidebarOld() {
     return [
         {
             text: "Welcome",
             items: [
-                {
-                    text: "About",
-                    collapsed: true,
-                    link: "/about/company",
-                    items: [
-                        { text: "Company", link: "/about/company" },
-                        { text: "Products", link: "/about/products" },
-                        { text: "Plans", link: "/about/plans" },
-                        { text: "Support", link: "/about/support" },
-                        { text: "Community", link: "/about/community" },
-                        { text: "Open source", link: "/about/open-source" },
-                        { text: "Contribute", link: "/about/contribute" },
-                    ],
-                },
                 {
                     text: "Features",
                     collapsed: true,

+ 15 - 0
docs/docs/about/contribute.md

@@ -0,0 +1,15 @@
+---
+title: Contribute
+description: Details about how to contribute to Ente's docs
+---
+
+# Contributing
+
+To contribute to these docs, you can use the "Edit this page" button at the
+bottom of each page. This will allow you to directly edit the markdown file that
+is used to generate this documentation and open a quick pull request directly
+from GitHub's UI.
+
+If you're more comfortable in contributing with your text editor, see the
+`docs/` folder of our GitHub repository,
+[github.com/ente-io/ente](https://github.com/ente-io/ente).

+ 29 - 82
docs/docs/about/index.md

@@ -5,19 +5,26 @@ description: >
     that we make.
 ---
 
-Ente is a platform for privately, reliably, and securely storing your data on
-the cloud. On top of this platform, Ente offers two products currently:
+# About
 
-* Ente Photos - An alternative to Google Photos and Apple Photos
+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 Auth - A (free!) app for storing your 2FA codes.
+* **Ente Photos** - An alternative to Google Photos and Apple Photos
 
-and more products are in the pipeline.
+* **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
+browser without you needing to install anything.
+
+More products are in the pipeline.
 
 ## History
 
-Ente was the founded by Vishnu Mohandas, who is also the Ente's CEO, in response
-to privacy concerns with major tech companies. The underlying motivation was the
+Ente was the founded by Vishnu Mohandas (he's also Ente's CEO) in response to
+privacy concerns with major tech companies. The underlying motivation was the
 understanding that big tech had no incentive to fix their act, but with
 end-to-end encrypted cross platform apps, there was a way for people to take
 back control over their own data without sacrificing on features.
@@ -29,9 +36,9 @@ has the literal meaning "my photos".
 
 This was a good name, but still Vishnu looked around for better ones. But one
 day, he discovered that "ente" means "duck" in German. This unexpected
-connection sealed the deal! We should ask him why he likes ducks so much, but
+connection sealed the deal. We should ask him why he likes ducks so much, but
 apparently he does, so this dual meaning ("mine" / "duck") led him to finalize
-the name, and also led to the adoption of the duck as Ente's mascot, "Ducky":
+the name, and also led to the adoption of "Ducky", Ente's mascot:
 
 <div align="center">
 
@@ -43,80 +50,20 @@ the name, and also led to the adoption of the duck as Ente's mascot, "Ducky":
 
 en-_tay_. Like ca<i>fe</i>.
 
----
-
-# Products
-
-Ente currently offers Photo and Auth. Additionally, there are some other
-products (Lockers and Legacy) that are being considered.
-
-## Ente Photos
-
-Ente Photos goes beyond traditional cloud storage, prioritizing your privacy and
-the safety of your cherished memories. All your photos, along with their
-metadata, are stored end-to-end encrypted, ensuring that only you have access to
-your data.
-
-Ente preserves your encrypted photos across three different clouds in three
-separate locations, including an underground fallout shelter. This multi-layered
-backup strategy provides a high level of reliability.
-
-Ente photos is available for Android, iOS, Linux, Mac, Windows and the web.
-
-# Ente Auth
-
-Ente auth is ust an authenticator app; it's an open-source initiative
-dedicated to securing your 2FA secrets. Now, you can backup and view your
-two-factor authentication secrets seamlessly. find more information about the
-project on GitHub at github.com/ente-io/auth.
-
-As a token of gratitude to the community that has supported us, Ente Auth is
-offered as a free service. If in the future we convert this to a paid service,
-existing users will be grandfathered in.
-
-Ente auth is available on Android, iOS, and the web
-
-# Connect with Ente
-
-## Customer support
-
-Connect with our support team for swift assistance and expert guidance email us
-@support@ente.io.
-Reach out to our dev team @team@ente.io, even our CEO and CTO personally
-responds here.
-
-## Blog
-
-As Ente continues to evolve, So does our story. Follow our blog @
-https://ente.io/blog As Ente undergoes continuous growth and development, our
-narrative unfolds. Explore our blog for exclusive company updates that offer an
-insider's perspective. Regularly visit the Ente blog to maintain your
-connection, stay well informed, and draw insipration.
-
-## Roadmap
-
-You plays a pivotal role in shaping the future direction of Ente's product, and
-we invite you to be an integral part of it.
-
-Take a look at our roadmap to see where we're headed
-https://roadmap.ente.io/roadmap/
-
-# Community
-
-#### Join our vibrant community and stay updated on all things on Ente! Follow us on various platforms for the latest news, updates, and engaging content
-
-#### Discord
-
-Join our Discord for real-time discussions, solutions to queries, and a thriving
-camaraderie. Stay updated on all things on Ente!
-
-🐦 Twitter: https://twitter.com/enteio
-
-🔗 Reddit: https://www.reddit.com/r/enteio
+## Get in touch
 
-📸 Instagram: https://www.instagram.com/ente.app/
+If you have a support query that is not answered by these docs, please reach out
+to our Customer Support by sending an email to support@ente.io
 
-🐘 Mastodon: https://mstdn.social/@ente
+To stay up to date with new product launches, and behind the scenes details of
+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))
 
-🔗 LinkedIn: https://www.linkedin.com/company/ente-io/
+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)
 
+Or if you'd just like to hang out, join our
+[Discord](https://discord.gg/z2YVKkycX3), follow us on
+[Twitter](https://twitter.com/enteio) or give us a shout out on
+[Mastodon](https://mstdn.social/@ente)

+ 6 - 6
docs/docs/auth/index.md

@@ -3,13 +3,13 @@ title: Ente Auth
 description: User guide for Ente Auth
 ---
 
-# Welcome to the Ente Auth's User Guide!
+# Ente Auth
 
-Ente Auth is a free, cross-platform, end-to-end encrypted authenticator app for
-everyone. You can use it to safely store your 2FA codes (second-factor
-authentication codes).
+Ente Auth is a free, cross-platform, end-to-end encrypted authenticator app. You
+can use it to safely store your 2FA codes (second-factor authentication codes).
 
 > [!CAUTION]
 >
-> These docs are still incomplete. If you feel like contributing though, help us
-> [fill them in](https://github.com/ente-io/ente/docs).
+> These docs are still incomplete. If you feel like documenting an issue you ran
+> into and then found a solution to, help us [fill them
+> in](/about/contributing).

+ 9 - 0
docs/docs/auth/migration-guides/index.md

@@ -0,0 +1,9 @@
+---
+title: Migrating to Ente Auth
+description: Guides for migrating your existing 2FA tokens from other products into Ente Auth
+---
+
+# Migrating to Ente Auth
+
+_Coming soon_. This section will contain guides for migrating your existing 2FA
+tokens from other products into Ente Auth.

+ 0 - 8
docs/docs/auth/support/contribute.md

@@ -1,8 +0,0 @@
-## Translation
-
-## Icons
-
-## Support Development
-
-If you wish to support the development of the project, please consider switching
-to paid plan of [Ente Photos](https://ente.io)

+ 2 - 2
docs/docs/de/auth/index.md

@@ -3,11 +3,11 @@ title: Ente Auth
 description: Ente Auth-Benutzerhandbuch
 ---
 
-# Willkommen beim Ente Auth-Benutzerhandbuch!
+# Ente Auth
 
 Ente Authenticator ist eine kostenlose, plattformübergreifende,
 Ende-zu-Ende-verschlüsselte Authenticator-App für jedermann. Wir sind froh, dass
 du hier bist!
 
 **Please note that this German translation is currently just a placeholder.**
-Know German? [Help us fill this in!](https://github.com/ente-io/ente/docs).
+Know German? [Help us fill this in!](/about/contributing).

+ 16 - 0
docs/docs/index.md

@@ -0,0 +1,16 @@
+---
+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.
+
+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
+jump directly to page that might contain the information you need.
+
+To know more about Ente, see [about](/about/) or visit our website
+[ente.io](https://ente.io).

+ 0 - 0
docs/docs/photos/faq/faq.md


+ 9 - 0
docs/docs/photos/faq/index.md

@@ -0,0 +1,9 @@
+---
+title: FAQ
+description: Frequently asked questions about Ente Photos
+---
+
+# FAQ
+
+_Coming soon_. On this page we'll document some help items in a question and
+answer format.

+ 41 - 27
docs/docs/photos/features/albums.md

@@ -1,67 +1,81 @@
+---
+title: Albums
+description: Using albums in Ente Photos
+---
+
 # Albums
 
-This guide will show you how to make the most of your albums with simple yet
-effective features. Below are the features that allow you to personailze your
-albums according to your preferences:
+Make the most of your albums and personalize them to your preferences with these
+simple yet effective features.
+
+## Rename album
 
-## 1. Rename album: Personalize your albums by giving them a meaningful name
+Personalize your albums by giving them a meaningful name.
 
-### How to Rename an album on your mobile?
+### How to rename an album on your mobile?
 
 -   Open the album
 -   Tap the three dots button in the top right corner of the screen
--   Tap rename album, then type in a new name
--   Tap on Rename button
+-   Tap _Rename album_, then type in a new name
+-   Tap on _Rename_ button
 
-### How to Rename an album on your Desktop?
+### How to rename an album on your web / desktop?
 
 -   Open the album
 -   Click on the overflow menu in the top right corner
--   Click the Rename album
+-   Click the _Rename album_ button
 -   Type in a new name
--   Click on Rename or Press enter
+-   Click on _Rename_ or press enter
+
+## Set album cover
 
-## 2. Set cover: Select any photo you want to use as the cover for your album.
+Select any photo you want to use as the cover for your album.
 
 ### How to set an album cover on mobile?
 
 -   Open the album you want to change
 -   Tap the three dots button in the top right corner
--   From the menu options, select Set cover
+-   From the menu options, select _Set cover_
 -   A new screen will appear, propmpting you to select the cover photo
 -   Browse through your photos and tap on the image you want to set as the album
     cover
--   Then tap on Use selected photo
+-   Then tap on _Use selected photo_
 
-## 3. Map: Explore the memories based on their location
+## View your photos on a map
 
-### How to explore the album's photo in map view?
+Explore your memories based on their location.
+
+### How to explore the album's photos in map view?
 
 -   Open the album
 -   Tap on the three dots button in the top right corner
--   Select map
--   View all photos of the album in map view
+-   Select _Map_
+-   This will show all photos of the album in a map view
+
+## Sort albums
 
-## 4. Sort by: Maintain order in your albums by arranging them from the newest to the oldest
+Maintain order in your albums by arranging them from the newest to the oldest.
 
-### How to sort by on mobile?
+### How to change the sort order on mobile?
 
 -   Open the album
 -   Tap on the three dots button in the top right corner
--   Select sort by
--   Tap on the Newst first for the latest, Or Oldest first for the oldest
+-   Select _Sort by_
+-   Tap on the _Newest first_ for the latest, Or _Oldest first_ for the oldest
 
-### How to sort by on desktop?
+### How to change the sort order on web / desktop?
 
 -   Open the album
 -   Click on the three dots button in the top right corner
--   Click sort by
--   Click on the Newest first for the latest, Or oldest first for the oldest
+-   Click _Sort by_
+-   Tap on the _Newest first_ for the latest, Or _Oldest first_ for the oldest
+
+## Pin albums
 
-## 5. Pin album: Keep your favorite album at the top by pinning them for quick access.
+Keep your favorite album at the top by pinning them for quick access.
 
-### How to Pin/Unpin an album on Mobile?
+### How to pin/unpin an album on mobile?
 
 -   Open the album
 -   Tap on the three dots button in the top right corner
--   Tap on Pin album/Unpin album
+-   Tap on _Pin album_ / _Unpin album_

+ 16 - 9
docs/docs/photos/features/archive.md

@@ -1,3 +1,10 @@
+---
+title: Archive
+description: |
+    Archiving photos and albums in Ente Photos to remove them from your home
+    timeline
+---
+
 # Archive
 
 You can remove a photo (owned by you) or an album from your **home timeline** by
@@ -8,30 +15,30 @@ mobile app.
     when some of the photos are also present in a non-archived album.
 -   You can archive albums that are owned by you or shared with you.
 -   Search results will include archived photos. If you want to hide photos from
-    search result, use [Hide](./hidden.md) feature.
+    search result, use [Hide](./hide) feature.
 
-### How to
+## How to
 
-#### Archive Album
+### Archive Album
 
 -   Open the album
 -   Click on the overflow menu
 -   Click on Archive album
 
-#### Archive Photo
+### Archive Photo
 
 -   Long press to select the photo
 -   Select Archive option from the bottom menu.
 
-#### View Archived Photos and Albums
+### View Archived Photos and Albums
 
-**Mobile**
+#### Mobile
 
 -   Go to Albums tab
 -   Scroll down to bottom
 -   Click on Archive button.
 
-**Desktop**
+#### Web / Desktop
 
 -   Click on the topleft hamburger menu
 -   Click on Archive
@@ -39,8 +46,8 @@ mobile app.
 ### Metadata Privacy
 
 Both Ente and the person with whom you are sharing an album or photo have no
-information about whether you have
+information about whether you have:
 
 -   Archived a photo
 -   Archived an album
--   Archived a shared album.
+-   Archived a shared album

+ 0 - 36
docs/docs/photos/features/cast.md

@@ -1,36 +0,0 @@
-# Cast
-
-With ente Cast, you can play a slideshow of your favourite albums on your Google
-Chromecast TVs or other Internet-connected large screen devices.
-
-## Get Started
-
-1. Open ente on the web or on your mobile device.
-2. Select the album you want to play on your large screen device.
-3. Click "Play album on TV" in the album menu.
-
-On the web, you can find this menu in the balls menu on the right hand side.
-![Balls menu](/assets/cast/web-play-album-on-tv.webp)
-
-4. Choose how you want to pair your device with your large screen device.
-   ![Pairing options](/assets/cast/web-pairing-options.webp)
-
-On 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.
-
-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
-[cast.ente.io](https://cast.ente.io) on your large screen device.
-
-5. Enter the PIN displayed on your large screen device into the input field on
-   your mobile or web device.
-
-On your large screen device, you'll see the following screen.
-![Pairing screen](/assets/cast/tv-pairing-screen.webp)
-
-6. If you entered your PIN correctly, you'll see a screen on your TV with a
-   green checkmark confirming the connection.

+ 65 - 0
docs/docs/photos/features/cast/index.md

@@ -0,0 +1,65 @@
+---
+title: Archive
+description: |
+    Archiving photos and albums in Ente Photos to remove them from your home
+    timeline
+---
+
+> [!CAUTION]
+>
+> This is preview documentation for an upcoming feature. This feature has not
+> yet been released yet, so the steps below will not work currently.
+
+# Cast
+
+With Ente Cast, you can play a slideshow of your favourite albums on your Google
+Chromecast TVs or other Internet-connected large screen devices.
+
+## Get Started
+
+1. Open ente on the web or on your mobile device.
+2. Select the album you want to play on your large screen device.
+3. Click "Play album on TV" in the album menu.
+
+    On the web, you can find this option in the three dots menu on the right
+    hand side.
+
+<div align="center">
+
+![Album options menu](web-play-album-on-tv.webp){width=300px}
+
+</div>
+
+4. Choose how you want to pair your device with your large screen device.
+
+    <div align="center">
+
+    ![Pairing options](web-pairing-options.webp){width=300px}
+
+    </div>
+
+    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.
+
+    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
+    [cast.ente.io](https://cast.ente.io) on your large screen device.
+
+5. Enter the PIN displayed on your large screen device into the input field on
+   your mobile or web device.
+
+    On your large screen device, you'll see the following screen.
+
+<div align="center">
+
+![Pairing screen](tv-pairing-screen.webp)
+
+</div>
+
+6. Once you enter the correct PIN, you will see a screen on your TV with a green
+   checkmark confirming the connection. Your photos will start showing up in a
+   bit.

+ 0 - 0
docs/docs/public/assets/cast/tv-pairing-screen.webp → docs/docs/photos/features/cast/tv-pairing-screen.webp


+ 0 - 0
docs/docs/public/assets/cast/web-pairing-options.webp → docs/docs/photos/features/cast/web-pairing-options.webp


+ 0 - 0
docs/docs/public/assets/cast/web-play-album-on-tv.webp → docs/docs/photos/features/cast/web-play-album-on-tv.webp


+ 17 - 12
docs/docs/photos/features/collect.md

@@ -1,4 +1,11 @@
-# Collect photos: Collecting memories from events is now a breeze!
+---
+title: Collect
+description: Collecting photos from others using Ente Photos
+---
+
+# Collect photos
+
+Collecting memories from events is now a breeze!
 
 -   Whether it's a birthday party, vacation trip or wedding, easily share your
     album using a unique, secure, end-to-end encrypted link.
@@ -6,23 +13,21 @@
     contribute without an ente account.
 -   This allows them to effortlessly add, view, and download photos from the
     link without an ente account.
--   Also preserves metadata and photo quality
+-   Also preserves metadata and photo quality.
 
-## How to Collect photos on mobile?
+## How to collect photos on mobile?
 
 -   Open the album you want to share with
 -   Tap on the Share album icon in the top right corner of the screen
--   Select 'Collect photos'
--   Tap 'Copy link'
--   The link has been copied to your clipboard. Now, feel free to share it
-
-## How to Collect photos on Web/Desktop?
+-   Select _Collect photos_
+-   Tap _Copy link_
+-   The link will get copied to your clipboard. Now, feel free to share it
 
-To collect photos on the web/desktop:
+## How to Collect photos on web / desktop?
 
 -   Open the album
 -   Click on the share album icon
--   Select Collect photos
--   Click on Copy link
--   The link has been copied to your clipboard. Share it effortlessly with
+-   Select _Collect photos_
+-   Click on _Copy link_
+-   The link will get copied to your clipboard. Share it effortlessly with
     others!

+ 6 - 1
docs/docs/photos/features/family-plan.md → docs/docs/photos/features/family-plans.md

@@ -1,9 +1,14 @@
+---
+title: Family plans
+description: Share your Ente Photos plan with your family members with no extra cost
+---
+
 # Family plans
 
 Paid subscribers of Ente can share the storage with their family, **at no
 additional cost** as you have already paid for the storage.
 
-In breif,
+In brief,
 
 -   Your family members can use storage space from your plan without paying
     extra.

+ 27 - 20
docs/docs/photos/features/hidden.md → docs/docs/photos/features/hide.md

@@ -1,59 +1,66 @@
-# Hidden
+---
+title: Hiding photos and albums
+description: Hide photos and albums in Ente Photos
+---
+
+# Hiding photos and albums
 
 You can further protect extra sensitive photos or albums by hiding them. Hidden
 photos or albums will **only be viewable** after an extra layer of
-authentication inside the app. Hidden differs from [Archive](./archive.md) in
-the fact that hidden photos won't be surfaced anywhere in the app without
-explicit authentication, whereas Archive only removes them from the home
-timeline and memories sections.
+authentication inside the app. Hiding differs from [Archiving](./archive.md) in
+that the hidden photos won't be surfaced anywhere in the app without explicit
+authentication, whereas archiving only removes them from the home timeline and
+memories sections.
 
 -   Hidden photos and albums will be removed from home timelines, memories,
     albums tab, search results, and any other visable place in the app.
+
 -   Hidden photos will be removed from all regular albums. If you want to unhide
     again you will have to specify the album to move it to.
+
 -   You cannot hide photos or albums shared with you. You can archive shared
     albums instead.
 
-### How to
+## How to
 
-#### Hide album
+### Hide album
 
 -   Open the album
 -   Click on the overflow menu
--   Click on Hide album
+-   Click on _Hide album_
 
-#### Hide photo
+### Hide photo
 
 -   Select the photo
--   Click on Hide option from the select menu
+-   Click on _Hide_ option from the select menu
 
-#### View hidden photos and albums
+### View hidden photos and albums
 
-_Mobile_:
+#### Mobile
 
 -   Go to Albums tab
 -   Scroll down to bottom
--   Click on Hidden button
+-   Click on _Hidden_ button
 -   Authenticate in app
 
-_Desktop_:
+#### Web / Desktop
 
 -   Click on the topleft hamburger menu
--   Click on Hidden
+-   Click on _Hidden_
 -   Authenticate in app
 
-#### Unhide album
+### Unhide album
 
 -   Open the hidden album
 -   Click on the overflow menu
--   Click on Unhide album
+-   Click on _Unhide album_
 
-#### Unhide photo
+### Unhide photo
 
 -   Select the hidden photo
--   Click on Unhide option from the select menu
+-   Click on _Unhide_ option from the select menu
 -   Click on the album the photo should be restored to
 
-### Metadata Privacy
+## Metadata Privacy
 
 Ente has no information about whether you have hidden a photo or album.

+ 0 - 0
docs/docs/photos/features/live-photos.md


+ 43 - 0
docs/docs/photos/features/location-tags.md

@@ -0,0 +1,43 @@
+---
+title: Location tags
+description: Search and organize your photos by location in Ente Photos
+---
+
+# Location Tags
+
+_Search and organize your photos by their location_
+
+Location Tags allow you to search and organize your photos based on their
+geographical location. Instead of sending your queries to our servers, we've
+implemented a privacy-friendly solution that runs searches locally on your
+device.
+
+## How to use Location Tags
+
+### Method 1: Adding Location Tags from a Photo
+
+1. Open a photo
+2. Click on _Info_
+3. Select _Add Location_"
+4. Enter the location name and define a radius
+
+### Method 2: Adding Location Tags from the Search Tab
+
+1. Go to the search tab
+2. Click on _Add new_ at the end of the location tags section
+3. Select a photo as the center point for the location tag
+4. Enter the location name and define a radius
+
+## Tips
+
+-   The app will automatically cluster photos falling within a radius under a
+    specified location.
+
+-   Location Tags provide a seamless way to filter photos without compromising
+    your privacy.
+
+-   Location tags are stored end-to-end encrypted, ensuring the security of your
+    data.
+
+-   Enjoy a more organized photo library by tagging important places like home,
+    office, and vacation spots.

+ 0 - 35
docs/docs/photos/features/location.md

@@ -1,35 +0,0 @@
-# Location Tags: Search and Organize Your Photos
-
-## Overview:
-
-The Location Tags feature allows you to efficiently search and organize your
-photos based on their geographical location. Instead of sending your queries to
-our servers, we've implemented a privacy-friendly solution that runs searches
-locally on your device.
-
-## How to Use Location Tags:
-
-### Method 1: Adding Location Tags from a Photo
-
-1. Open a photo.
-2. Click on "Info."
-3. Select "Add Location."
-4. Enter the location name and define a radius.
-
-### Method 2: Adding Location Tags from the Search Tab
-
-1. Go to the search tab.
-2. Click on "Add new" at the end of the location tags section.
-3. Select a photo as the center point for the location tag.
-4. Enter the location name and define a radius.
-
-## Note:
-
--   The app will automatically cluster photos falling within a radius under a
-    specified location.
--   Location Tags provide a seamless way to filter photos without compromising
-    your privacy.
--   Location tags are stored end-to-end encrypted, ensuring the security of your
-    data.
--   Enjoy a more organized photo library by tagging important places like home,
-    office, and vacation spots.

+ 27 - 22
docs/docs/photos/features/map.md

@@ -1,34 +1,39 @@
-# Map : View and explore your photos on the map
+---
+title: Maps
+description: View and explore your photos on a map within Ente Photos
+---
+
+# Map
+
+_View and explore your photos on the map_
 
 ## How can I view photos on the map on mobile?
 
--   Step 1. Find the search icon located at the bottom right corner of your
-    screen.
--   Step 2. Tap on the globe icon (Your map) withing the location
--   Step 3. Enter the map view and start exploring your photos from around the
-    world.
+-   Find the search icon located at the bottom right corner of your screen.
+-   Tap on the globe icon (Your map) withing the location
+-   Enter the map view and start exploring your photos from around the world.
 
 ## How to enable map on your mobile app?
 
--   Step 1. Tap the three horizontal lines located at the top left corner of
-    your home screen or swipe left on the home screen.
--   Step 2. Select "General" settings.
--   Step 3. Enter the "Advanced" settings.
--   Step 4. Use the toggle switch to turn the map feature on or off
+-   Tap the three horizontal lines located at the top left corner of your home
+    screen or swipe left on the home screen.
+-   Select _General_ settings.
+-   Enter the _Advanced_ settings.
+-   Use the toggle switch to turn the map feature on or off.
 
 ## How to view Album photos on the map?
 
--   Step 1. Open the album containing the photos you want to view
--   Step 2. Tap on the three horizontal lines located in the top right corner of
-    the screen.
--   Step 3. Select "Map" from the options.
--   Step 4. View and explore your photos on the map.
+-   Open the album containing the photos you want to view
+-   Tap on the three horizontal lines located in the top right corner of the
+    screen.
+-   Select _Map_ from the options.
+-   View and explore your photos on the map.
 
 ## How to enable map on desktop?
 
--   Step 1. Click on the three horizontal lines located in the top left corner
-    of the app.
--   Step 2. Navigate to "preferences" from the menu.
--   Step 3. Select "Advanced" in the preference menu.
--   Step 4. Click on "Map" to access map settings.
--   Step 5. Toggle the map settings on and off based on your preferences.
+-   Click on the three horizontal lines located in the top left corner of the
+    app.
+-   Navigate to _Preferences_ from the menu.
+-   Select _Advanced_ in the preferences menu.
+-   Click on _Map_ to access map settings.
+-   Toggle the map settings on and off based on your preferences.

+ 5 - 0
docs/docs/photos/features/public-links.md

@@ -1,3 +1,8 @@
+---
+title: Public links
+description: Share photos with your friends and family without them needing to install Ente Photos
+---
+
 # Public Links
 
 Ente lets you share your photos via links, that can be accessed by anyone,

+ 15 - 5
docs/docs/photos/features/quick-link.md

@@ -1,12 +1,22 @@
+---
+title: Quick links
+description: Share photos with your friends and family without creating albums
+---
+
 # Quick Links
 
-Quick links allows you to select single or multiple photos & create a link.
-Behind the scene, ente creates a special album and put all the selected files in
-that special album.
+Quick links allows you to select single or multiple photos and create a link
+that you can then share. You don't need to create an album first.
+
+> Behind the scene, Ente creates a special album and put all the selected files
+> in that special album.
 
 -   You can view all quick links created by you in the sharing tab, under Quick
     links section.
+
 -   Quick links can be converted to regular album.
--   Remove link will not delete the photos that are present in that link.
--   Similar to [public-links](./public-links.md), you can set link expirty, set
+
+-   Removing a link will not delete the photos that are present in that link.
+
+-   Similar to [public-links](./public-links), you can set link expiry,
     passwords or device limits.

+ 20 - 15
docs/docs/photos/features/referral.md → docs/docs/photos/features/referrals.md

@@ -1,6 +1,11 @@
-# Referral plan: Earn and Expand Your Storage
+---
+title: Referral plan
+description: Earn and expand your storage by referring Ente Photos to your friends and family
+---
 
-## Overview:
+# Referral plan
+
+_Earn and Expand Your Storage_
 
 Did you know you can boost your storage on Ente simply by referring your
 friends? Our referral program lets you earn 10 GB of free storage for each
@@ -13,29 +18,29 @@ On the Home Page:
 
 -   Click on the hamburger menu in the top left corner
 -   Open the sidebar
--   Tap on 'General'
--   Select Referrals
+-   Tap on _General_
+-   Select _Referrals_
 -   Share the code with your friend or family
 
 Note:
 
 -   Once your friend upgrades to a paid plan, both you and your friend receive
-    an additional 10 GB of storage
--   Keep track of your earned storage and referral details on Claim free storage
-    screen
+    an additional 10 GB of storage.
+-   You can keep track of your earned storage and referral details on _Claim
+    free storage_ screen.
 -   If you refer more friends than your plan allows, the extra storage earned
-    will be reserved until you upgrade your plan
--   Earned storage remains accessible as long as your subscription is active
+    will be reserved until you upgrade your plan.
+-   Earned storage remains accessible as long as your subscription is active.
 
-## How to apply Refferal code of a friend?
+## How to apply referral code given by a friend?
 
 On the Home Page:
 
 -   Click on the hamburger menu inthe top left corner
--   Tap on 'General' from the options
--   Select 'Referrals' from the menu
--   Find and tap on 'Apply Code.'
+-   Tap on _General_ from the options
+-   Select _Referrals_ from the menu
+-   Find and tap on _Apply Code_
 -   Enter the referral code provided by your friend.
 
-Note: Please note that referral codes should be applied within one month of
-account creation to claim free storage.
+Please note that referral codes should be applied within one month of account
+creation to claim the free storage.

+ 8 - 3
docs/docs/photos/features/trash.md

@@ -1,7 +1,12 @@
+---
+title: Trash
+description: Deleting items and trash
+---
+
 # Trash
 
-Whenever you delete an item from ente, it is moved to Trash. These items will be
-automatically deleted from Trash after 30 days. You can manaully select or
-completely empty the trash, if you wish.
+Whenever you delete an item from Ente, it is moved to Trash. These items will be
+automatically deleted from Trash after 30 days. You can manaully select photos
+to permanently delete or completely empty the trash if you wish.
 
 Items in trash are included in your used storage calculation.

+ 14 - 8
docs/docs/photos/features/uncategorized.md

@@ -1,18 +1,24 @@
-## Uncategoried
+---
+title: Uncategorized
+description: Uncategorized items in Ente Photos
+---
 
-"Uncategorized" is a special album type where photos are automatically added
+# Uncategorized
+
+_Uncategorized_ is a special album type where photos are automatically added
 under the following circumstances:
 
 -   When you remove a photo from the last album, it is relocated to
-    "Uncategorized."
+    _Uncategorized_ section.
+
 -   During album deletion, if you choose to keep photos but delete the album,
-    all photos exclusive to the current album are moved to the "Uncategorized"
+    all photos exclusive to the current album are moved to the _Uncategorized_
     section.
 
 Note: This does not include photos uploaded by others.
 
-### Clean up Uncategorized
+### Cleaning up Uncategorized items
 
-In the mobile app, you can click on the overflow menu and click
-`Clean Uncategorized` option. All files that are also present in another album,
-that is owned by the user, will be removed from the Uncategorized section.
+In the mobile app, you can click on the overflow menu and click _Clean
+Uncategorized_ option. All files that are also present in another album, that is
+owned by the user, will be removed from the _Uncategorized_ section.

+ 20 - 14
docs/docs/photos/features/watch-folder.md

@@ -1,30 +1,36 @@
-# Watched Folders: Effortless Syncing
+---
+title: Watch folder
+description: Automatic syncing of certain folders in the Ente Photos desktop app
+---
 
-## Overview:
+# Watch folder
 
-The ente desktop app now allows you to "watch" a folder on your computer for any
-changes, creating a one-way sync from your device to the Ente cloud. This will
-make photo management and backup a breeze.
+_Automatic syncing_
+
+The Ente desktop app allows you to "watch" a folder on your computer for any
+changes, creating a one-way sync from your device to the Ente cloud. This is
+intended to automate your photo management and backup.
 
 ## How to add Watch folders?
 
 -   Click on the hamburger menu in the top left corner
 -   Open the sidebar
--   Select "Watch Folders"
--   Choose "Add Watch Folders"
--   Pick the folder from your system that you want to add as Watch folder
+-   Select _Watch Folders_
+-   Choose _Add Watch Folders_
+-   Pick the folder from your system that you want to add as a watched folder
 
 ## How to remove Watch folders?
 
 -   Click on the hamburger menu in the top left corner
 -   Open the sidebar
--   Select "Watch Folders"
+-   Select _Watch Folders_
 -   Click on the three dots menu next to the folders on the right side
--   Choose "Stop Watching" from the menu
+-   Choose _Stop Watching_ from the menu
+
+# Tips:
 
-# Note:
+-   You will get an option to choose whether to sync nested folders to a single
+    album or separate albums.
 
--   Option to choose whether to sync nested folders to a single album or
-    separate albums.
 -   The app continuously monitors changes in the watched folder, such as the
-    addition or removal of files
+    addition or removal of files.

+ 0 - 0
docs/docs/photos/getting-started/index.md


+ 14 - 38
docs/docs/photos/index.md

@@ -1,42 +1,18 @@
-# Welcome to Help!
+---
+title: Ente Photos
+description: User guide for Ente Photos
+---
 
-Welcome to Ente Photos Help! If you're new to Ente Photos, our
-[Quick Start](./getting-started/index.md) and [FAQs](./faq/faq.md) are great
-places to begin.
+# Ente Photos
 
-If you can’t find an answer, please [ask the community](https://ente.io/discord)
-or write to **support@ente.io**.
+Ente Photos is an end-to-end encrypted alternative to Google Photos and Apple
+Photos. You can use it to safely and securely store your photos on the cloud.
 
-To send a bug report or a feature suggestion, you can use
-[Github Issues](https://github.com/ente-io/photos-app/issues).
+While security and privacy form the bedrock of Ente Photos, it is not at the
+cost of usability. The user interface is simple, and we are continuously working
+to make it even simpler. The goal is a product that can be used by people with
+all sorts of technical ability and background.
 
-Feedback about this documentation can be shared on our
-[Discord Server](https://ente.io/discord) in the **\#docs** channel. We would
-love to hear your thoughts on anything we can fix or improve.
-
-## About Ente Photos
-
-[Ente Photos](https://ente.io) is a safe home for your photos and videos.
-
-You can store, share, and re-discover your moments with absolute privacy.
-
-## About Ente Auth
-
-[Ente Auth](https://ente.io/auth) is a secure, end-to-end encrypted 2FA app with
-multi-platform sync.
-
-Learn more about Auth [here](../authenticator/).
-
-## Contributing
-
-The source for this documentation is available at
-[github.com/ente-io/docs](https://github.com/ente-io/docs).
-
-Please see our
-[contribution guide](https://github.com/ente-io/docs#contributing). We'd be
-grateful for any fixes and improvements!
-
-Once your contributions are accepted, please add yourself to the list of
-[Contributors](./misc/contributors.md).
-
-Thank you!
+These help docs are divided into three sections: Features, FAQ and
+Troubleshooting. Choose the relevant page from the sidebar menu, or use the
+search at the top.

+ 0 - 0
docs/docs/photos/misc/contributors.md


+ 12 - 6
docs/docs/photos/troubleshooting/files-not-uploading.md

@@ -1,13 +1,19 @@
+---
+title: Files not uploading
+description: Troubleshooting when files are not uploading from your Ente Photos app
+---
+
+# Files not uploading
+
 ## Network Issue
 
 If you are using VPN, please try disabling the VPN or switching provider.
 
-## Web/Desktop
+## Web / Desktop
 
-**Certain file types are not uploading**
+### Certain file types are not uploading
 
 The desktop/web app tries to detect if a particular file is video or image. If
-the detection fails, then the app skips the upload. Please share either the
-sample file or logs with us @support.ente.io
-
-## Mobile
+the detection fails, then the app skips the upload. Please contact our
+[support](support.ente.io) if you find that a valid file did not get detected
+and uploaded.

+ 0 - 15
docs/docs/photos/troubleshooting/report-bug.md

@@ -1,15 +0,0 @@
-## Report Bug
-
-Guide to help the user in sharing logs.
-
-### Mobile
-
-Placeholder
-
-### Desktop
-
-Placeholder
-
-### Web
-
-Placeholder

+ 26 - 0
docs/docs/photos/troubleshooting/sharing-logs.md

@@ -0,0 +1,26 @@
+---
+title: Sharing logs with support
+description: How to report bugs and share the logs from your Ente Photos app
+---
+
+# Sharing debug logs
+
+In some cases when you report a bug, our customer support might request you to
+share debug logs from your app to help our developers find the issue.
+
+Note that the debug logs contain potentially sensitive information like the file
+names, so please feel free to not share them if you have any hesitation or want
+to keep these private. We will try to diagnose the issue even without the logs,
+the logs just make the process a bit faster and easier.
+
+### Mobile
+
+Placeholder
+
+### Desktop
+
+Placeholder
+
+### Web
+
+Placeholder

+ 0 - 5
docs/docs/photos/troubleshooting/video-not-playing.md

@@ -1,5 +0,0 @@
-## Video Playback Issue
-
-### Web
-
-### Desktop / Mobile

+ 1 - 1
docs/package.json

@@ -9,6 +9,6 @@
     },
     "devDependencies": {
         "prettier": "^3",
-        "vitepress": "^1.0.0-rc.44"
+        "vitepress": "^1.0.0-rc.45"
     }
 }

+ 4 - 4
docs/yarn.lock

@@ -723,10 +723,10 @@ vite@^5.1.3:
   optionalDependencies:
     fsevents "~2.3.3"
 
-vitepress@^1.0.0-rc.44:
-  version "1.0.0-rc.44"
-  resolved "https://registry.yarnpkg.com/vitepress/-/vitepress-1.0.0-rc.44.tgz#01bce883761c22de42b9869a95f04bd02cbb8cdb"
-  integrity sha512-tO5taxGI7fSpBK1D8zrZTyJJERlyU9nnt0jHSt3fywfq3VKn977Hg0wUuTkEmwXlFYwuW26+6+3xorf4nD3XvA==
+vitepress@^1.0.0-rc.45:
+  version "1.0.0-rc.45"
+  resolved "https://registry.yarnpkg.com/vitepress/-/vitepress-1.0.0-rc.45.tgz#1cb41f53fa084c224dd2d910137ef7b2e8c0c191"
+  integrity sha512-/OiYsu5UKpQKA2c0BAZkfyywjfauDjvXyv6Mo4Ra57m5n4Bxg1HgUGoth1CLH2vwUbR/BHvDA9zOM0RDvgeSVQ==
   dependencies:
     "@docsearch/css" "^3.5.2"
     "@docsearch/js" "^3.5.2"