also looking at this
Add BunPress guide and pre-E2E quality gates
#4
246 files
+1744
-64381
| @@ -4,177 +4,53 @@ const config: BunPressOptions = { | ||
| 4 | 4 | verbose: false, |
| 5 | 5 | docsDir: './docs', |
| 6 | 6 | outDir: './dist/docs', |
| 7 | ||
| 8 | // Navigation | |
| 9 | 7 | nav: [ |
| 10 | { | |
| 11 | text: 'Changelog', | |
| 12 | link: 'https://github.com/stacksjs/stacks/blob/main/CHANGELOG.md', | |
| 13 | }, | |
| 14 | { | |
| 15 | text: 'Resources', | |
| 16 | items: [ | |
| 17 | { text: 'Team', link: '/team' }, | |
| 18 | { text: 'Sponsors', link: '/sponsors' }, | |
| 19 | { text: 'Partners', link: '/partners' }, | |
| 20 | { text: 'Postcardware', link: '/postcardware' }, | |
| 21 | { text: 'Awesome Stacks', link: 'https://github.com/stacksjs/awesome-stacks' }, | |
| 22 | { text: 'Contributing', link: 'https://github.com/stacksjs/stacks/blob/main/.github/CONTRIBUTING.md' }, | |
| 23 | ], | |
| 24 | }, | |
| 8 | { text: 'Quick start', link: '/getting-started' }, | |
| 9 | { text: 'SDKs', link: '/send/sdks' }, | |
| 10 | { text: 'Ingest API', link: '/reference/ingest' }, | |
| 11 | { text: 'Dashboard', link: 'https://loghq.org/dashboard' }, | |
| 12 | { text: 'GitHub', link: 'https://github.com/stacksjs/loghq' }, | |
| 25 | 13 | ], |
| 26 | ||
| 27 | // Markdown configuration | |
| 28 | 14 | markdown: { |
| 29 | title: 'Stacks Documentation', | |
| 30 | meta: { | |
| 31 | description: 'Rapid application, cloud & library development framework.', | |
| 32 | author: 'Stacks.js', | |
| 33 | }, | |
| 15 | title: 'LogHQ Documentation', | |
| 16 | meta: { description: 'Send, search, correlate, retain, and operate structured application logs with LogHQ.', author: 'LogHQ' }, | |
| 34 | 17 | syntaxHighlightTheme: 'github-dark', |
| 35 | toc: { | |
| 36 | enabled: true, | |
| 37 | minDepth: 2, | |
| 38 | maxDepth: 3, | |
| 39 | }, | |
| 18 | toc: { enabled: true, minDepth: 2, maxDepth: 3 }, | |
| 40 | 19 | sidebar: { |
| 41 | 20 | '/': [ |
| 42 | { | |
| 43 | text: 'Prologue', | |
| 44 | collapsed: true, | |
| 45 | items: [ | |
| 46 | { text: 'Release Notes', link: '/release-notes' }, | |
| 47 | { text: 'Upgrade Guide', link: '/upgrade-guide' }, | |
| 48 | { text: 'Contribution Guide', link: '/contribution-guide' }, | |
| 49 | { text: 'Sponsors', link: '/sponsors' }, | |
| 50 | ], | |
| 51 | }, | |
| 52 | { | |
| 53 | text: 'Getting Started', | |
| 54 | collapsed: true, | |
| 55 | items: [ | |
| 56 | { text: 'Introduction', link: '/guide/intro' }, | |
| 57 | { text: 'Quick Start', link: '/guide/get-started' }, | |
| 58 | ], | |
| 59 | }, | |
| 60 | { | |
| 61 | text: 'Basics', | |
| 62 | collapsed: true, | |
| 63 | items: [ | |
| 64 | { text: 'Routing', link: '/basics/routing' }, | |
| 65 | { text: 'Middleware', link: '/basics/middleware' }, | |
| 66 | { text: 'Models', link: '/basics/models' }, | |
| 67 | { text: 'Views', link: '/basics/views' }, | |
| 68 | { text: 'Actions', link: '/basics/actions' }, | |
| 69 | { text: 'Commands', link: '/basics/commands' }, | |
| 70 | { text: 'Jobs', link: '/basics/jobs' }, | |
| 71 | { text: 'Components', link: '/basics/components' }, | |
| 72 | { text: 'Functions', link: '/basics/functions' }, | |
| 73 | { text: 'Validation', link: '/packages/validation' }, | |
| 74 | { text: 'Error Handling', link: '/basics/error-handling' }, | |
| 75 | { text: 'Logging', link: '/basics/logging' }, | |
| 76 | ], | |
| 77 | }, | |
| 78 | { | |
| 79 | text: 'Digging Deeper', | |
| 80 | collapsed: true, | |
| 81 | items: [ | |
| 82 | { text: 'Authentication', link: '/guide/auth' }, | |
| 83 | { text: 'Database', link: '/packages/database' }, | |
| 84 | { text: 'Cache', link: '/packages/cache' }, | |
| 85 | { text: 'Events', link: '/packages/events' }, | |
| 86 | { text: 'Queue', link: '/packages/queue' }, | |
| 87 | { text: 'Notifications', link: '/packages/notifications' }, | |
| 88 | { text: 'Payments', link: '/packages/payments' }, | |
| 89 | { text: 'Realtime', link: '/packages/realtime' }, | |
| 90 | { text: 'Search Engine', link: '/packages/search-engine' }, | |
| 91 | { text: 'Storage', link: '/packages/storage' }, | |
| 92 | ], | |
| 93 | }, | |
| 94 | { | |
| 95 | text: 'Cloud', | |
| 96 | collapsed: true, | |
| 97 | items: [ | |
| 98 | { text: 'Deploy', link: '/guide/cloud/deployment' }, | |
| 99 | { text: 'Extend Cloud', link: '/guide/cloud/extend' }, | |
| 100 | ], | |
| 101 | }, | |
| 102 | { | |
| 103 | text: 'CLI (Buddy)', | |
| 104 | collapsed: true, | |
| 105 | items: [ | |
| 106 | { text: 'Introduction', link: '/guide/buddy/intro' }, | |
| 107 | { text: 'Dev', link: '/guide/buddy/dev' }, | |
| 108 | { text: 'Build', link: '/guide/buddy/build' }, | |
| 109 | { text: 'Deploy', link: '/guide/buddy/deploy' }, | |
| 110 | { text: 'Make', link: '/guide/buddy/make' }, | |
| 111 | { text: 'Migrate', link: '/guide/buddy/migrate' }, | |
| 112 | { text: 'Test', link: '/guide/buddy/test' }, | |
| 113 | ], | |
| 114 | }, | |
| 115 | { | |
| 116 | text: 'Packages', | |
| 117 | collapsed: true, | |
| 118 | items: [ | |
| 119 | { text: 'Actions', link: '/packages/actions' }, | |
| 120 | { text: 'AI', link: '/packages/ai' }, | |
| 121 | { text: 'Auth', link: '/packages/auth' }, | |
| 122 | { text: 'Cache', link: '/packages/cache' }, | |
| 123 | { text: 'CLI', link: '/packages/cli' }, | |
| 124 | { text: 'Cloud', link: '/packages/cloud' }, | |
| 125 | { text: 'Database', link: '/packages/database' }, | |
| 126 | { text: 'ORM', link: '/packages/orm' }, | |
| 127 | { text: 'Query Builder', link: '/packages/query-builder' }, | |
| 128 | { text: 'Router', link: '/packages/router' }, | |
| 129 | { text: 'Testing', link: '/packages/testing' }, | |
| 130 | { text: 'Validation', link: '/packages/validation' }, | |
| 131 | ], | |
| 132 | }, | |
| 133 | { | |
| 134 | text: 'Testing', | |
| 135 | collapsed: true, | |
| 136 | items: [ | |
| 137 | { text: 'Getting Started', link: '/testing/getting-started' }, | |
| 138 | { text: 'Unit Tests', link: '/testing/unit-tests' }, | |
| 139 | { text: 'Feature Tests', link: '/testing/feature-tests' }, | |
| 140 | { text: 'Http Tests', link: '/testing/http-tests' }, | |
| 141 | { text: 'Browser Tests', link: '/testing/browser-tests' }, | |
| 142 | ], | |
| 143 | }, | |
| 144 | { | |
| 145 | text: 'Project', | |
| 146 | collapsed: true, | |
| 147 | items: [ | |
| 148 | { text: 'Roadmap', link: '/project/roadmap' }, | |
| 149 | { text: 'Contributing', link: '/project/contributing' }, | |
| 150 | { text: 'License', link: '/project/license' }, | |
| 151 | ], | |
| 152 | }, | |
| 153 | ], | |
| 154 | }, | |
| 155 | themeConfig: { | |
| 156 | logo: '/images/logos/logo-transparent.svg', | |
| 157 | footer: { | |
| 158 | message: 'Released under the MIT License.', | |
| 159 | copyright: 'Copyright 2024-present Stacks.js, Inc.', | |
| 160 | }, | |
| 161 | socialLinks: [ | |
| 162 | { icon: 'twitter', link: 'https://twitter.com/stacksjs' }, | |
| 163 | { icon: 'github', link: 'https://github.com/stacksjs/stacks' }, | |
| 164 | { icon: 'discord', link: 'https://discord.gg/stacksjs' }, | |
| 21 | { text: 'Introduction', items: [ | |
| 22 | { text: 'What is LogHQ', link: '/introduction' }, | |
| 23 | { text: 'Quick start', link: '/getting-started' }, | |
| 24 | ] }, | |
| 25 | { text: 'Send logs', items: [ | |
| 26 | { text: 'Stacks, PHP, and Laravel', link: '/send/sdks' }, | |
| 27 | { text: 'HTTP from any language', link: '/send/http' }, | |
| 28 | ] }, | |
| 29 | { text: 'Use LogHQ', items: [ | |
| 30 | { text: 'Search and filters', link: '/use/search-filters' }, | |
| 31 | { text: 'Correlation', link: '/use/correlation' }, | |
| 32 | { text: 'Projects and teams', link: '/use/projects-teams' }, | |
| 33 | { text: 'Alert channels', link: '/use/alerts' }, | |
| 34 | ] }, | |
| 35 | { text: 'Operate', items: [ | |
| 36 | { text: 'Retention and archive', link: '/operate/retention-archive' }, | |
| 37 | { text: 'Self-hosting', link: '/operate/self-hosting' }, | |
| 38 | ] }, | |
| 39 | { text: 'Reference', items: [ | |
| 40 | { text: 'Ingest API', link: '/reference/ingest' }, | |
| 41 | { text: 'Dashboard API', link: '/reference/api' }, | |
| 42 | { text: 'CLI', link: '/reference/cli' }, | |
| 43 | ] }, | |
| 165 | 44 | ], |
| 166 | 45 | }, |
| 167 | 46 | }, |
| 168 | ||
| 169 | // SEO Configuration | |
| 170 | sitemap: { | |
| 171 | enabled: true, | |
| 172 | baseUrl: 'https://stacksjs.com/docs', | |
| 173 | }, | |
| 174 | ||
| 175 | robots: { | |
| 176 | enabled: true, | |
| 47 | themeConfig: { | |
| 48 | darkMode: 'auto', | |
| 49 | footer: { message: 'Open-source log management, released under the MIT License.', copyright: 'Copyright 2026-present LogHQ' }, | |
| 50 | socialLinks: [{ icon: 'github', link: 'https://github.com/stacksjs/loghq' }], | |
| 177 | 51 | }, |
| 52 | sitemap: { enabled: true, baseUrl: 'https://loghq.org/docs' }, | |
| 53 | robots: { enabled: true }, | |
| 178 | 54 | } |
| 179 | 55 | |
| 180 | 56 | export default config |