From 05938b16c992ca9d1ba9f7f6f61bec1c2bf80680 Mon Sep 17 00:00:00 2001 From: Daniel Steigerwald Date: Thu, 30 Nov 2023 23:26:26 +0100 Subject: [PATCH] Improve docs structure --- apps/web/pages/_meta.json | 10 +++++----- apps/web/pages/docs/_meta.json | 4 ++-- apps/web/pages/docs/{why-evolu.mdx => index.mdx} | 2 +- apps/web/pages/docs/{guide.mdx => quickstart.mdx} | 2 +- apps/web/pages/index.mdx | 4 ++-- 5 files changed, 11 insertions(+), 11 deletions(-) rename apps/web/pages/docs/{why-evolu.mdx => index.mdx} (99%) rename apps/web/pages/docs/{guide.mdx => quickstart.mdx} (99%) diff --git a/apps/web/pages/_meta.json b/apps/web/pages/_meta.json index 361d3a16a..cb326536d 100644 --- a/apps/web/pages/_meta.json +++ b/apps/web/pages/_meta.json @@ -1,15 +1,15 @@ { "index": { - "title": "Home", "type": "page", + "title": "Home", "display": "hidden" }, "docs": { - "title": "Docs", - "type": "page" + "type": "page", + "title": "Documentation" }, "examples": { - "title": "Examples", - "type": "page" + "type": "page", + "title": "Examples" } } diff --git a/apps/web/pages/docs/_meta.json b/apps/web/pages/docs/_meta.json index 156f026e2..cb58ce286 100644 --- a/apps/web/pages/docs/_meta.json +++ b/apps/web/pages/docs/_meta.json @@ -1,7 +1,7 @@ { - "why-evolu": "Why Evolu?", + "index": "Introduction", "installation": "Installation", - "guide": "Guide", + "quickstart": "Quickstart", "api": "API", "how-evolu-works": "How Evolu Works", "faq": "FAQ", diff --git a/apps/web/pages/docs/why-evolu.mdx b/apps/web/pages/docs/index.mdx similarity index 99% rename from apps/web/pages/docs/why-evolu.mdx rename to apps/web/pages/docs/index.mdx index 46ac9b170..1e27043e0 100644 --- a/apps/web/pages/docs/why-evolu.mdx +++ b/apps/web/pages/docs/index.mdx @@ -1,4 +1,4 @@ -# Why Evolu? +# Evolu Evolu is a library for local-first apps, so the question should be, why local-first apps? diff --git a/apps/web/pages/docs/guide.mdx b/apps/web/pages/docs/quickstart.mdx similarity index 99% rename from apps/web/pages/docs/guide.mdx rename to apps/web/pages/docs/quickstart.mdx index a037c4867..a33300c0d 100644 --- a/apps/web/pages/docs/guide.mdx +++ b/apps/web/pages/docs/quickstart.mdx @@ -1,4 +1,4 @@ -# Guide +# Quickstart Learn how to build a minimal Evolu application. You can use [Next.js](https://nextjs.org/) or any other [React](https://reactjs.org/) meta-framework. diff --git a/apps/web/pages/index.mdx b/apps/web/pages/index.mdx index a70932e0a..622766a3f 100644 --- a/apps/web/pages/index.mdx +++ b/apps/web/pages/index.mdx @@ -6,7 +6,7 @@ title: Evolu - Local-first platform designed for privacy, ease of use, and no ve [Local-first](https://www.inkandswitch.com/local-first/) apps allow users to own their data. Evolu stores data in the user's device(s), so Evolu apps can work offline. Evolu merges data changes made on different devices without conflicts using -Conflict-free Replicated Data Type (CRDT). [How Evolu Works](docs/how-evolu-works) +Conflict-free Replicated Data Type (CRDT). import { Callout } from "nextra-theme-docs"; @@ -14,7 +14,7 @@ import { Callout } from "nextra-theme-docs"; Evolu is designed for privacy, ease of use, and no vendor lock-in. -[Getting Started](/docs/getting-started) · [GitHub Repository](https://github.com/evoluhq/evolu/) · [Twitter](https://twitter.com/evoluhq) +[Get started](/docs) · [GitHub repository](https://github.com/evoluhq/evolu/) ## Overview