From e26e4b5f0965b480dac5ff105c2eb2c8a674782a Mon Sep 17 00:00:00 2001 From: Anton Hughes Date: Thu, 3 Aug 2023 16:28:36 +1200 Subject: [PATCH] Add a lightweight intro --- src/content/docs/introduction.mdx | 75 +++---------------------------- 1 file changed, 6 insertions(+), 69 deletions(-) diff --git a/src/content/docs/introduction.mdx b/src/content/docs/introduction.mdx index f46e7f3..840bd43 100644 --- a/src/content/docs/introduction.mdx +++ b/src/content/docs/introduction.mdx @@ -1,76 +1,13 @@ --- -title: "Installation" +title: "Introduction" outline: ["what-is-gena" , "getting-started", "installation","configuring-the-sidebar ", "adding-content", "deployment-and-build", "other-helpful-docs"] --- -# what is gena? -It is a ready template to help you get strarted writting documentation as quick as possible. - -It is built with `Astro` + `tailwindCSS` + `mdx` - -## getting started - -### installation -Read the [installation guide](./installation). - -### configuring the sidebar - -the left sidebar is configuration is on the `src/content.ts` file.
-edit the file in order to change the content of the sidebar. - -```ts -// src/content.ts -export const sidebarStructure = [ - { - label: "Getting Started", - children: [ - { - label: "introduction", - path: "./docs/introduction", - }, - { - label: "installation", - path: "./docs/installation", - }, - ], - } -]; -``` -
-configuring the right sidebar happens in the markdown/mdx file in the `content` folder. - -example `content/docs/introduction.mdx`. - - -```md ---- -title: "Introduction" -outline: ["getting-started", "installation"] ---- - -rest of the markdown... -``` -
- -### adding content - -To add more content to the template, just add more `markdown\mdx` files to the `content/docs` directory.
-The routing is done automatically by -Astro, [read about router here](https://docs.astro.build/core-concepts/routing/). - -note: -> To change it from the docs directory you'll have to change `src/content.ts` -```js -export const docsDir = "docs"; -``` -
+# What is this? -### deployment and build -static files are generated hence your docs can be deployed anywhere you want, [read more here](https://docs.astro.build/guides/deploy/). -
+These documents are intended to inspire key conversations and practical steps that will lead to: -### other helpful docs -1. [Astro](https://astro.build/) -2. [tailwindcss](https://tailwindcss.com/) -3. [mdx](https://mdxjs.com/) +- a collective that makes informed decisions +- a transparent sharing of information that lead up to specific decision +- an informed and empowered collective \ No newline at end of file