From c9489975260cc89c40eb398bd690125f2fb0187b Mon Sep 17 00:00:00 2001 From: David Barrat Date: Tue, 19 Dec 2023 00:39:14 +0100 Subject: [PATCH] docs: cleanup --- apps/docs/package.json | 2 +- apps/docs/pages/_meta.json | 14 ++------- apps/docs/pages/about.mdx | 3 -- apps/docs/pages/advanced.mdx | 3 -- apps/docs/pages/advanced/satori.mdx | 3 -- apps/docs/pages/another.mdx | 31 -------------------- apps/docs/pages/cli/commands.mdx | 1 + apps/docs/pages/get-started/installation.mdx | 29 ++++++++++++++++++ apps/docs/pages/index.mdx | 19 +++++++----- apps/docs/theme.config.tsx | 4 +-- pnpm-lock.yaml | 6 ---- 11 files changed, 47 insertions(+), 68 deletions(-) delete mode 100644 apps/docs/pages/about.mdx delete mode 100644 apps/docs/pages/advanced.mdx delete mode 100644 apps/docs/pages/advanced/satori.mdx delete mode 100644 apps/docs/pages/another.mdx create mode 100644 apps/docs/pages/cli/commands.mdx create mode 100644 apps/docs/pages/get-started/installation.mdx diff --git a/apps/docs/package.json b/apps/docs/package.json index b1965f1..106ce6c 100644 --- a/apps/docs/package.json +++ b/apps/docs/package.json @@ -1,5 +1,5 @@ { - "name": "@hydra/docs", + "name": "@authdog/hydra-docs", "version": "0.0.1", "private": true, "description": "GraphQL Hydra docs", diff --git a/apps/docs/pages/_meta.json b/apps/docs/pages/_meta.json index 164927d..ff619a4 100644 --- a/apps/docs/pages/_meta.json +++ b/apps/docs/pages/_meta.json @@ -1,15 +1,5 @@ { "index": "Introduction", - "another": "Another Page", - "advanced": "Advanced (A Folder)", - "about": { - "title": "About", - "type": "page" - }, - "contact": { - "title": "Contact ↗", - "type": "page", - "href": "https://twitter.com/shuding_", - "newWindow": true - } + "get-started": "Get Started", + "cli": "CLI" } diff --git a/apps/docs/pages/about.mdx b/apps/docs/pages/about.mdx deleted file mode 100644 index ec6faed..0000000 --- a/apps/docs/pages/about.mdx +++ /dev/null @@ -1,3 +0,0 @@ -# About - -This is the about page! This page is shown on the navbar. diff --git a/apps/docs/pages/advanced.mdx b/apps/docs/pages/advanced.mdx deleted file mode 100644 index a1a5148..0000000 --- a/apps/docs/pages/advanced.mdx +++ /dev/null @@ -1,3 +0,0 @@ -# Advanced - -This is the index page for the Advanced folder! diff --git a/apps/docs/pages/advanced/satori.mdx b/apps/docs/pages/advanced/satori.mdx deleted file mode 100644 index 46eb19f..0000000 --- a/apps/docs/pages/advanced/satori.mdx +++ /dev/null @@ -1,3 +0,0 @@ -# Satori - -Satori (悟り) is a Japanese Buddhist term for awakening, "comprehension; understanding". diff --git a/apps/docs/pages/another.mdx b/apps/docs/pages/another.mdx deleted file mode 100644 index 7fb6a02..0000000 --- a/apps/docs/pages/another.mdx +++ /dev/null @@ -1,31 +0,0 @@ -# Another Page - -```js filename="demo.js" {3} copy -let a = 1; - -console.log(a); -``` - -## Component - -import { useState } from 'react' - -{/* Import CSS modules */} -import styles from '../components/counters.module.css' - -export const Counter = () => { - const [count, setCount] = useState(0); - return ( -
- -
- ); -}; - - - -## External Component - -import Counters from '../components/counters' - - diff --git a/apps/docs/pages/cli/commands.mdx b/apps/docs/pages/cli/commands.mdx new file mode 100644 index 0000000..e682742 --- /dev/null +++ b/apps/docs/pages/cli/commands.mdx @@ -0,0 +1 @@ +# Commands \ No newline at end of file diff --git a/apps/docs/pages/get-started/installation.mdx b/apps/docs/pages/get-started/installation.mdx new file mode 100644 index 0000000..0e4cc73 --- /dev/null +++ b/apps/docs/pages/get-started/installation.mdx @@ -0,0 +1,29 @@ +import { Tabs } from 'nextra/components' + +# Installation + +## Prerequisites + +- NodeJS installed (16+ recommended) +- npm installed (or similar NodeJS packages manager) + +## Setup + + + + + ```bash {3} copy + sudo pnpm add -g @authdog/hydra-cli + ``` + + + ```bash {3} copy + sudo npm install -g @authdog/hydra-cli + ``` + + + ```bash {3} copy + sudo yarn global add @authdog/hydra-cli + ``` + + \ No newline at end of file diff --git a/apps/docs/pages/index.mdx b/apps/docs/pages/index.mdx index 058465c..fc05757 100644 --- a/apps/docs/pages/index.mdx +++ b/apps/docs/pages/index.mdx @@ -1,11 +1,16 @@ -# Introduction - -Welcome to Nextra! This is a basic docs template. You can use it as a starting point for your own project :) +# What is Hydra? -## What is Nextra? +Hydra is a lightweight framework written in TypeScript designed to solve Edge caching challenges for GraphQL endpoints such as automated caching and invalidation of queries, built-in security. -A **simple**, **powerful** and **flexible** site generation framework with everything you love from Next.js. +The core aspects of Hydra are: -## Documentation +- Self-hosted framework +- Operates natively with Authdog backend (OpenID, Authz) +- Cost effectiveness, 100% Edge Computing based +- Automated mutation based invalidation +- Automated cache segmentation +- Cloudflare opinionated (KV, Durable Objects) -The documentation is available at [https://nextra.site](https://nextra.site). +Most Hydra operations can be achieved through Hydra CLI. + +We'll walkthrough the installation process in the next section. \ No newline at end of file diff --git a/apps/docs/theme.config.tsx b/apps/docs/theme.config.tsx index 3e7c056..917baf0 100644 --- a/apps/docs/theme.config.tsx +++ b/apps/docs/theme.config.tsx @@ -13,11 +13,11 @@ const config: DocsThemeConfig = { link: "https://github.com/authdog/hydra", }, chat: { - link: "https://discord.com", + link: "https://corp.auth.dog/discord", }, docsRepositoryBase: "https://github.com/authdog/hydra/docs", footer: { - text: "Hydra docs", + text: `Hydra is an Open Source product of Authdog, LLC. - © ${new Date().getFullYear()} Authdog, LLC.`, }, }; diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 795d975..d5efde7 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -133,12 +133,6 @@ importers: specifier: ^5.2.2 version: 5.2.2 - packages/create-hydra-app: - devDependencies: - typescript: - specifier: ^5.2.2 - version: 5.2.2 - services/itty-hydra: dependencies: '@authdog/hydra-core':