Skip to content

Commit

Permalink
docs: cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
dbrrt committed Dec 18, 2023
1 parent e9827b7 commit c948997
Show file tree
Hide file tree
Showing 11 changed files with 47 additions and 68 deletions.
2 changes: 1 addition & 1 deletion apps/docs/package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "@hydra/docs",
"name": "@authdog/hydra-docs",
"version": "0.0.1",
"private": true,
"description": "GraphQL Hydra docs",
Expand Down
14 changes: 2 additions & 12 deletions apps/docs/pages/_meta.json
Original file line number Diff line number Diff line change
@@ -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"
}
3 changes: 0 additions & 3 deletions apps/docs/pages/about.mdx

This file was deleted.

3 changes: 0 additions & 3 deletions apps/docs/pages/advanced.mdx

This file was deleted.

3 changes: 0 additions & 3 deletions apps/docs/pages/advanced/satori.mdx

This file was deleted.

31 changes: 0 additions & 31 deletions apps/docs/pages/another.mdx

This file was deleted.

1 change: 1 addition & 0 deletions apps/docs/pages/cli/commands.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Commands
29 changes: 29 additions & 0 deletions apps/docs/pages/get-started/installation.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
import { Tabs } from 'nextra/components'

# Installation

## Prerequisites

- NodeJS installed (16+ recommended)
- npm installed (or similar NodeJS packages manager)

## Setup


<Tabs items={['pnpm', 'npm', 'yarn']}>
<Tabs.Tab>
```bash {3} copy
sudo pnpm add -g @authdog/hydra-cli
```
</Tabs.Tab>
<Tabs.Tab>
```bash {3} copy
sudo npm install -g @authdog/hydra-cli
```
</Tabs.Tab>
<Tabs.Tab>
```bash {3} copy
sudo yarn global add @authdog/hydra-cli
```
</Tabs.Tab>
</Tabs>
19 changes: 12 additions & 7 deletions apps/docs/pages/index.mdx
Original file line number Diff line number Diff line change
@@ -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.
4 changes: 2 additions & 2 deletions apps/docs/theme.config.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -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.`,
},
};

Expand Down
6 changes: 0 additions & 6 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit c948997

Please sign in to comment.