diff --git a/docs/docs/.vitepress/sidebar.ts b/docs/docs/.vitepress/sidebar.ts index 448541cc2e..8a0754ad7e 100644 --- a/docs/docs/.vitepress/sidebar.ts +++ b/docs/docs/.vitepress/sidebar.ts @@ -9,13 +9,17 @@ export const sidebar = [ text: "Introduction", link: "/overview/", }, + { + text: "Community", + link: "/overview/community", + }, { text: "Contributing", link: "/overview/contribute", }, { text: "Help", - link: "/overview/community", + link: "/overview/help", }, ], }, diff --git a/docs/docs/overview/community.md b/docs/docs/overview/community.md index 806aa45d6a..aecc9a0df5 100644 --- a/docs/docs/overview/community.md +++ b/docs/docs/overview/community.md @@ -1,17 +1,10 @@ --- -title: Get in touch +title: Community description: > - Get in touch with Ente for support, stay updated, suggest new features and - join the community + Information regarding Ente's community channels --- -# Get in touch - -## Support - -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](mailto:support@ente.io) +# Community ## Blog @@ -19,12 +12,6 @@ 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)) -## Suggest a feature - -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) - ## Community Or if you'd just like to hang out, join our diff --git a/docs/docs/overview/contribute.md b/docs/docs/overview/contribute.md index 3addd2e606..406de6c480 100644 --- a/docs/docs/overview/contribute.md +++ b/docs/docs/overview/contribute.md @@ -1,10 +1,18 @@ --- title: Contribute -description: Details about how to contribute to Ente's docs +description: Details about how to contribute to Ente --- # Contributing +## Suggest a feature + +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) + +## Documentation + 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 diff --git a/docs/docs/overview/help.md b/docs/docs/overview/help.md new file mode 100644 index 0000000000..43aeded5af --- /dev/null +++ b/docs/docs/overview/help.md @@ -0,0 +1,13 @@ +--- +title: Help +description: Get help from Ente via customer support and community +--- + +# Help + +If you encounter any issues with any of the products that's not answered by our +[documentation](/), please reach out to our Customer Support by sending an email +to [support@ente.io](mailto:support@ente.io) + +For community support, please post your queries on +[Discord](https://discord.gg/z2YVKkycX3) diff --git a/docs/docs/overview/index.md b/docs/docs/overview/index.md index 3ba1aa3193..063d2c6675 100644 --- a/docs/docs/overview/index.md +++ b/docs/docs/overview/index.md @@ -16,8 +16,8 @@ this platform, Ente offers two products: - **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. +(Android and iOS) platforms. They also work directly in your web browser without +you needing to install anything. More products are in the pipeline. diff --git a/docs/package.json b/docs/package.json index bd7635b126..a714aea110 100644 --- a/docs/package.json +++ b/docs/package.json @@ -5,7 +5,8 @@ "dev": "vitepress dev docs", "build": "vitepress build docs", "preview": "vitepress preview docs", - "pretty": "prettier --write ." + "pretty": "prettier --write .", + "pretty:check": "prettier -c ." }, "devDependencies": { "prettier": "^3.3.4",