Mention the pending publishing

This commit is contained in:
Manav Rathi
2024-03-01 10:18:44 +05:30
parent 04f273cf56
commit dcdab150dc
2 changed files with 15 additions and 7 deletions

View File

@@ -2,6 +2,12 @@
Help and documentation for Ente's products
> [!CAUTION]
>
> **Currently not published**. There are minor bits we need to clean up before
> publishing these. They'll likely be available at help.ente.io once we wrap
> those loose ends up.
## Running
Install dependencies
@@ -24,11 +30,12 @@ local machine.
If you plan on contributing frequently, we recommend using an editor. VSCode is
a good choice. Also install the Prettier extension for VSCode, and set VSCode to
format on save. This will use the standard formatting and text wrapping options
for this project, so you can just focus on the content.
format on save. This way the editor will automatically format and wrap the text
using the project's standard, so you can just focus on the content.
We currently don't enforce the prettier formatting to make it easy for people
unfamiliar with programming to also be able to make edits from GitHub directly.
Note that we currently don't enforce these formatting standards to make it easy
for people unfamiliar with programming to also be able to make edits from GitHub
directly.
This is a common theme - unlike the rest of the codebase where we expect some
baseline understanding of the tools involved, the docs are meant to be a place

View File

@@ -2,7 +2,7 @@ import { defineConfig } from "vitepress";
// https://vitepress.dev/reference/site-config
export default defineConfig({
title: "Ente Help",
title: "Ente Docs",
description: "Help and documentation for Ente's products",
head: [
[
@@ -25,7 +25,8 @@ export default defineConfig({
themeConfig: {
// https://vitepress.dev/reference/default-theme-config
editLink: {
pattern: "https://github.com/ente-io/docs/edit/main/docs/:path",
pattern:
"https://github.com/ente-io/ente/edit/main/docs/docs/:path",
},
nav: [
{ text: "Photos", link: "/photos/index" },
@@ -44,7 +45,7 @@ export default defineConfig({
"/authenticator/": sidebarAuth(),
},
socialLinks: [
{ icon: "github", link: "https://github.com/ente-io/docs/" },
{ icon: "github", link: "https://github.com/ente-io/ente/" },
],
},
});