feat: add documentation website (#4)

kibu-sh · Oct 2, 2024 · 23e5de1 · 23e5de1
1 parent 13c086c
commit 23e5de1
Show file tree

Hide file tree

Showing 66 changed files with 5,280 additions and 41 deletions.
diff --git a/.github/workflows/website.yaml b/.github/workflows/website.yaml
@@ -0,0 +1,39 @@
+name: Deploy to GitHub Pages
+
+on:
+  # Trigger the workflow every time you push to the `main` branch
+  # Using a different branch name? Replace `main` with your branch’s name
+  push:
+    branches: [ main ]
+  # Allows you to run this workflow manually from the Actions tab on GitHub.
+  workflow_dispatch:
+
+# Allow this job to clone the repo and create a page deployment
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout your repository using git
+        uses: actions/checkout@v4
+      - name: Install, build, and upload your site
+        uses: withastro/action@v3
+        with:
+          path: docs
+          node-version: 20
+          package-manager: pnpm@latest
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4
diff --git a/docs/.gitignore b/docs/.gitignore
@@ -0,0 +1,22 @@
+# build output
+dist/
+# generated types
+.astro/
+.vscode/
+
+# dependencies
+node_modules/
+
+# logs
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+
+
+# environment variables
+.env
+.env.production
+
+# macOS-specific files
+.DS_Store
diff --git a/docs/001_start.md b/docs/001_start.md
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,56 @@
+# Starlight Starter Kit: Tailwind
+
+[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build)
+
+```
+npm create astro@latest -- --template starlight/tailwind
+```
+
+[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/starlight/tree/main/examples/tailwind)
+[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/starlight/tree/main/examples/tailwind)
+[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/withastro/starlight&create_from_path=examples/tailwind)
+[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fwithastro%2Fstarlight%2Ftree%2Fmain%2Fexamples%2Ftailwind&project-name=my-starlight-docs&repository-name=my-starlight-docs)
+
+> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
+
+## 🚀 Project Structure
+
+Inside of your Astro + Starlight project, you'll see the following folders and files:
+
+```
+.
+├── public/
+├── src/
+│   ├── assets/
+│   ├── content/
+│   │   ├── docs/
+│   │   └── config.ts
+│   └── env.d.ts
+├── astro.config.mjs
+├── package.json
+├── tailwind.config.mjs
+└── tsconfig.json
+```
+
+Starlight looks for `.md` or `.mdx` files in the `src/content/docs/` directory. Each file is exposed as a route based on its file name.
+
+Images can be added to `src/assets/` and embedded in Markdown with a relative link.
+
+Static assets, like favicons, can be placed in the `public/` directory.
+
+## 🧞 Commands
+
+All commands are run from the root of the project, from a terminal:
+
+| Command                   | Action                                           |
+| :------------------------ | :----------------------------------------------- |
+| `npm install`             | Installs dependencies                            |
+| `npm run dev`             | Starts local dev server at `localhost:4321`      |
+| `npm run build`           | Build your production site to `./dist/`          |
+| `npm run preview`         | Preview your build locally, before deploying     |
+| `npm run astro ...`       | Run CLI commands like `astro add`, `astro check` |
+| `npm run astro -- --help` | Get help using the Astro CLI                     |
+
+## 👀 Want to learn more?
+
+Check out [Starlight’s docs](https://starlight.astro.build/), read [the Astro documentation](https://docs.astro.build), or jump into the [Astro Discord server](https://astro.build/chat).
diff --git a/docs/astro.config.mjs b/docs/astro.config.mjs
@@ -0,0 +1,40 @@
+// @ts-check
+import starlight from '@astrojs/starlight'
+import tailwind from '@astrojs/tailwind'
+import { defineConfig } from 'astro/config'
+
+// https://astro.build/config
+export default defineConfig({
+  integrations: [
+    starlight({
+      title: 'Kibu Documentation',
+      logo: {
+        replacesTitle: true,
+        dark: './src/assets/logo dark.svg',
+        light: './src/assets/logo light.svg',
+      },
+      social: {
+        github: 'https://github.com/kibu-sh/kibu',
+        youtube: 'https://www.youtube.com/@kibu-sh',
+        twitter: 'https://twitter.com/kibu_sh',
+        discord: 'https://discord.gg/5sga863FVB',
+      },
+      sidebar: [
+        {
+          label: 'Guides',
+          autogenerate: { directory: 'guides' },
+          // items: [
+          //   // Each item here is one entry in the navigation menu.
+          //   // { label: 'Example Guide', slug: 'guides/example' },
+          // ],
+        },
+        {
+          label: 'Reference',
+          autogenerate: { directory: 'reference' },
+        },
+      ],
+      customCss: ['./src/tailwind.css'],
+    }),
+    tailwind({ applyBaseStyles: false }),
+  ],
+})
diff --git a/docs/client-gen.md b/docs/client-gen.md
diff --git a/docs/database.md b/docs/database.md
diff --git a/docs/encoding.md b/docs/encoding.md
diff --git a/docs/errors.md b/docs/errors.md
diff --git a/docs/filewatching.md b/docs/filewatching.md
diff --git a/docs/graphql.md b/docs/graphql.md
diff --git a/docs/grpc.md b/docs/grpc.md
diff --git a/docs/middleware.md b/docs/middleware.md
diff --git a/docs/migrations.md b/docs/migrations.md
diff --git a/docs/package.json b/docs/package.json
@@ -0,0 +1,22 @@
+{
+  "name": "docs",
+  "type": "module",
+  "version": "0.0.1",
+  "scripts": {
+    "dev": "astro dev",
+    "start": "astro dev",
+    "build": "astro check && astro build",
+    "preview": "astro preview",
+    "astro": "astro"
+  },
+  "dependencies": {
+    "@astrojs/starlight": "^0.28.2",
+    "@astrojs/starlight-tailwind": "^2.0.3",
+    "@astrojs/tailwind": "^5.1.0",
+    "astro": "^4.15.3",
+    "sharp": "^0.32.5",
+    "tailwindcss": "^3.4.4",
+    "@astrojs/check": "^0.9.3",
+    "typescript": "^5.6.2"
+  }
+}
diff --git a/docs/pub-sub.md b/docs/pub-sub.md
diff --git a/docs/public/favicon.svg b/docs/public/favicon.svg
diff --git a/docs/real-time-postgres.md b/docs/real-time-postgres.md
diff --git a/docs/rendering.md b/docs/rendering.md
diff --git a/docs/row-level-security.md b/docs/row-level-security.md
diff --git a/docs/src/assets/houston.webp b/docs/src/assets/houston.webp
diff --git a/docs/src/assets/logo dark.svg b/docs/src/assets/logo dark.svg
diff --git a/docs/src/assets/logo light.svg b/docs/src/assets/logo light.svg
diff --git a/docs/src/content/config.ts b/docs/src/content/config.ts
@@ -0,0 +1,6 @@
+import { defineCollection } from 'astro:content';
+import { docsSchema } from '@astrojs/starlight/schema';
+
+export const collections = {
+	docs: defineCollection({ schema: docsSchema() }),
+};
diff --git a/docs/Getting-Started.md → docs/src/content/docs/guides/001_start.md b/docs/Getting-Started.md → docs/src/content/docs/guides/001_start.md
@@ -1,7 +1,12 @@
+---
+title: Getting Started
+description: Quickly get started with Kibu
+---
+
 # Getting Started
 
 ## Install
-Install the cli and library by running the following commands in your terminal. 
+Install the cli and library by running the following commands in your terminal.
 ```bash
 go get github.com/kibu-sh/kibu
 go install github.com/kibu-sh/kibu/cmd/kibu@main
@@ -34,4 +39,10 @@ touch src/backend/systems/health/health.go
 touch src/backend/systems/health/healthspec/health_dto.go
 ```
 
-Once the wire.go and wire_set.go files have been created cd into the server directory and run wire once.
+Once the wire.go and wire_set.go files have been created cd into the server directory and run wire once.
+
+## Further reading
+
+- Read [about how-to guides](https://diataxis.fr/how-to-guides/) in the Diátaxis framework
+
+https://spiral.dev/ (as inspiration)
diff --git a/docs/Managing-Secrets-Configurations.md → ...guides/Managing-Secrets-Configurations.md b/docs/Managing-Secrets-Configurations.md → ...guides/Managing-Secrets-Configurations.md
@@ -1,3 +1,8 @@
+---
+title: Managing Secrets & Configurations
+description: TODO
+---
+
 # Managing Secrets &amp; Configurations
 
 ## Introduction

diff --git a/docs/authorization.md → .../src/content/docs/guides/authorization.md b/docs/authorization.md → .../src/content/docs/guides/authorization.md
@@ -1,3 +1,8 @@
+---
+title: Authorization
+description: TODO
+---
+
 provide interface allow many implementations
 defaults to postgres RLS and table based permissions
 maybe some other implementation from another library
diff --git a/docs/src/content/docs/guides/client-gen.md b/docs/src/content/docs/guides/client-gen.md
@@ -0,0 +1,4 @@
+---
+title: TODO
+description: TODO
+---
diff --git a/docs/src/content/docs/guides/database.md b/docs/src/content/docs/guides/database.md
@@ -0,0 +1,4 @@
+---
+title: Database
+description: TODO
+---
diff --git a/docs/src/content/docs/guides/encoding.md b/docs/src/content/docs/guides/encoding.md
@@ -0,0 +1,4 @@
+---
+title: Encoding
+description: TODO
+---
diff --git a/docs/src/content/docs/guides/errors.md b/docs/src/content/docs/guides/errors.md
@@ -0,0 +1,4 @@
+---
+title: TODO
+description: TODO
+---
diff --git a/docs/faq.md → docs/src/content/docs/guides/faq.md b/docs/faq.md → docs/src/content/docs/guides/faq.md
@@ -1,3 +1,8 @@
+---
+title: FAQ
+description: Frequently asked questions
+---
+
 Should I ignore generated files?
 
 We recommend ignoring the `*.gen.go` files and `kibugen`.

diff --git a/docs/src/content/docs/guides/filewatching.md b/docs/src/content/docs/guides/filewatching.md
@@ -0,0 +1,4 @@
+---
+title: File Watching
+description: TODO
+---
diff --git a/docs/go-gen.md → docs/src/content/docs/guides/go-gen.md b/docs/go-gen.md → docs/src/content/docs/guides/go-gen.md
@@ -1,3 +1,8 @@
+---
+title: Code Generation
+description: TODO
+---
+
 Write about code generation
 Cover topics like how to write a new generator
 What the data structures look like
diff --git a/docs/src/content/docs/guides/graphql.md b/docs/src/content/docs/guides/graphql.md
@@ -0,0 +1,4 @@
+---
+title: GraphQL
+description: TODO
+---
diff --git a/docs/src/content/docs/guides/grpc.md b/docs/src/content/docs/guides/grpc.md
@@ -0,0 +1,4 @@
+---
+title: gRPC
+description: TODO
+---
diff --git a/docs/src/content/docs/guides/middleware.md b/docs/src/content/docs/guides/middleware.md
@@ -0,0 +1,4 @@
+---
+title: Middleware
+description: TODO
+---
diff --git a/docs/src/content/docs/guides/migrations.md b/docs/src/content/docs/guides/migrations.md
@@ -0,0 +1,4 @@
+---
+title: Migrations
+description: TODO
+---
diff --git a/docs/src/content/docs/guides/pub-sub.md b/docs/src/content/docs/guides/pub-sub.md
@@ -0,0 +1,4 @@
+---
+title: Pub Sub
+description: TODO
+---
diff --git a/docs/queries.md → docs/src/content/docs/guides/queries.md b/docs/queries.md → docs/src/content/docs/guides/queries.md
@@ -1 +1,6 @@
+---
+title: Queries
+description: TODO
+---
+
 organizing migrations and queries into submodules
diff --git a/docs/src/content/docs/guides/real-time-postgres.md b/docs/src/content/docs/guides/real-time-postgres.md
@@ -0,0 +1,4 @@
+---
+title: Real Time Postgres
+description: Postgres Change Data Capture can trigger temporal workflows
+---
diff --git a/docs/src/content/docs/guides/rendering.md b/docs/src/content/docs/guides/rendering.md
@@ -0,0 +1,7 @@
+---
+title: Rendering
+description: TODO
+---
+
+HTMX
+TEMPL
diff --git a/docs/src/content/docs/guides/row-level-security.md b/docs/src/content/docs/guides/row-level-security.md
@@ -0,0 +1,4 @@
+---
+title: Row Level Security
+description: TODO
+---
diff --git a/docs/sqlc.md → docs/src/content/docs/guides/sqlc.md b/docs/sqlc.md → docs/src/content/docs/guides/sqlc.md
@@ -1,2 +1,7 @@
+---
+title: SQLC
+description: TODO
+---
+
 consider the sqlc plugin for ORM features
 https://github.com/volatiletech/sqlboiler
diff --git a/docs/src/content/docs/guides/testing.md b/docs/src/content/docs/guides/testing.md
@@ -0,0 +1,4 @@
+---
+title: Testing
+description: TODO
+---