From dcdab150dc307f773015f4b536b11fbcb3a7e888 Mon Sep 17 00:00:00 2001 From: Manav Rathi Date: Fri, 1 Mar 2024 10:18:44 +0530 Subject: [PATCH] Mention the pending publishing --- README.md | 15 +++++++++++---- docs/.vitepress/config.ts | 7 ++++--- 2 files changed, 15 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 82130d3414..e281afd2a2 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index c104c5da25..4676b17199 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -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/" }, ], }, });