also looking at this
docs: the documentation the README points at
#63
9 files
+509
-10
| @@ -4,9 +4,11 @@ import { env } from '@stacksjs/env' | ||
| 4 | 4 | /** |
| 5 | 5 | * **Documentation Configuration** |
| 6 | 6 | * |
| 7 | * Your app's documentation site, built with BunPress from `docs/`. There is no | |
| 8 | * `docs/` until you create one: add `docs/index.md` and `buddy dev` serves it | |
| 9 | * at /docs, and `buddy deploy` builds it. | |
| 7 | * Your app's documentation site, built with BunPress from `docs/`, served at | |
| 8 | * /docs by `buddy dev`. | |
| 9 | * | |
| 10 | * Every page below has to exist in `docs/`, because nothing checks that a nav | |
| 11 | * or sidebar link resolves. | |
| 10 | 12 | */ |
| 11 | 13 | |
| 12 | 14 | // APP_URL is often a bare host, which is not a URL on its own. |
| @@ -18,7 +20,12 @@ const config: BunPressOptions = { | ||
| 18 | 20 | docsDir: './docs', |
| 19 | 21 | outDir: './dist/docs', |
| 20 | 22 | |
| 21 | nav: [], | |
| 23 | nav: [ | |
| 24 | { text: 'Install', link: '/install' }, | |
| 25 | { text: 'Configuration', link: '/configuration' }, | |
| 26 | { text: 'Security', link: '/security' }, | |
| 27 | { text: 'GitHub', link: 'https://github.com/stacksjs/uplink' }, | |
| 28 | ], | |
| 22 | 29 | |
| 23 | 30 | markdown: { |
| 24 | 31 | title: `${env.APP_NAME || 'Uplink'} Documentation`, |
| @@ -38,6 +45,22 @@ const config: BunPressOptions = { | ||
| 38 | 45 | text: 'Getting Started', |
| 39 | 46 | items: [ |
| 40 | 47 | { text: 'Introduction', link: '/' }, |
| 48 | { text: 'Install', link: '/install' }, | |
| 49 | { text: 'Permissions', link: '/permissions' }, | |
| 50 | ], | |
| 51 | }, | |
| 52 | { | |
| 53 | text: 'Running it', | |
| 54 | items: [ | |
| 55 | { text: 'Configuration', link: '/configuration' }, | |
| 56 | { text: 'Security', link: '/security' }, | |
| 57 | ], | |
| 58 | }, | |
| 59 | { | |
| 60 | text: 'When it goes wrong', | |
| 61 | items: [ | |
| 62 | { text: 'Troubleshooting', link: '/troubleshooting' }, | |
| 63 | { text: 'Uninstall', link: '/uninstall' }, | |
| 41 | 64 | ], |
| 42 | 65 | }, |
| 43 | 66 | ], |