Skip to content

Where people and agents ship software together. The open-source git platform for the whole job: issues, agents, checks and deploys to the edge.

268 linesCodeBlameRaw
1// @ts-check
2import starlight from '@astrojs/starlight';
3import { defineConfig } from 'astro/config';
4
5import { generateApiReference } from './scripts/api-reference.mjs';
6
7// A page per REST operation, written from the OpenAPI document.
8const apiGroups = generateApiReference();
9
10export default defineConfig({
11 site: 'https://docs.g1t.sh',
12 // Pages that moved, so links already shared still arrive.
13 redirects: {
14 '/guides/inbox/': '/guides/notifications/',
15 '/guides/mirroring/': '/guides/github/',
16 '/guides/today/': '/guides/home/',
17 // g1t no longer runs agents of its own: coding agents connect to it.
18 '/guides/g1t-agents/': '/guides/bring-your-own-agent/',
19 '/guides/working-with-g1t/': '/guides/bring-your-own-agent/',
20 '/guides/agents/': '/guides/bring-your-own-agent/',
21 '/guides/agent-abilities/': '/guides/bring-your-own-agent/',
22 '/guides/agent-access/': '/guides/bring-your-own-agent/',
23 '/guides/agent-memory/': '/guides/bring-your-own-agent/',
24 '/guides/agent-routines/': '/guides/bring-your-own-agent/',
25 '/guides/agent-sessions/': '/guides/why-blame/',
26 '/guides/agent-skills/': '/guides/bring-your-own-agent/',
27 '/guides/agent-budgets/': '/guides/usage-and-billing/',
28 '/guides/agents-and-memory/': '/guides/bring-your-own-agent/',
29 '/guides/talking-to-agents/': '/guides/bring-your-own-agent/',
30 '/guides/chat-app/': '/guides/chat/',
31 '/guides/customize/': '/guides/bring-your-own-agent/',
32 '/guides/marketplace/': '/guides/bring-your-own-agent/',
33 '/guides/models/': '/guides/ai/',
34 '/guides/ai-gateway/': '/guides/ai/',
35 '/guides/context-hub/': '/guides/bring-your-own-agent/',
36 // Project and workspace memory is gone: harnesses keep their own.
37 '/guides/memory/': '/guides/bring-your-own-agent/',
38 '/guides/spend/': '/guides/usage-and-billing/',
39 '/guides/outcomes/': '/guides/milestones/',
40 // Issues became workspace work items: their operations moved with them.
41 '/reference/api/issues/list-issues/': '/reference/api/work-items/list-work-items/',
42 '/reference/api/issues/create-issue/': '/reference/api/work-items/open-work-item/',
43 '/reference/api/issues/get-issue/': '/reference/api/work-items/get-work-item/',
44 '/reference/api/issues/update-issue/': '/reference/api/work-items/update-work-item/',
45 '/reference/api/issues/close-issue/': '/reference/api/work-items/close-work-item/',
46 '/reference/api/issues/reopen-issue/': '/reference/api/work-items/reopen-work-item/',
47 '/reference/api/integrations/import-issue/': '/reference/api/work-items/import-work-items/',
48 },
49 integrations: [
50 starlight({
51 title: 'g1t docs',
52 description: 'Guides and reference for g1t, the code platform for your team and its coding agents.',
53 components: {
54 Footer: './src/components/Footer.astro',
55 Head: './src/components/Head.astro',
56 Header: './src/components/Header.astro',
57 PageTitle: './src/components/PageTitle.astro',
58 SiteTitle: './src/components/SiteTitle.astro',
59 SocialIcons: './src/components/SocialIcons.astro',
60 },
61 // Each tab under the header shows its own part of the sidebar.
62 routeMiddleware: './src/route-data.ts',
63 expressiveCode: {
64 // Dark first, as the base; the light one where the page is light.
65 // Starlight switches between them by <html data-theme>.
66 themes: ['github-dark-default', 'github-light-default'],
67 useDarkModeMediaQuery: false,
68 // Plain panels with a copy button, without window chrome.
69 defaultProps: { frame: 'none' },
70 styleOverrides: {
71 borderRadius: '0.75rem',
72 borderColor: 'var(--g1t-line)',
73 codeBackground: 'var(--g1t-surface)',
74 codeFontSize: '0.8125rem',
75 frames: {
76 editorBackground: 'var(--g1t-surface)',
77 terminalBackground: 'var(--g1t-surface)',
78 terminalTitlebarBackground: 'var(--g1t-raised)',
79 terminalTitlebarBorderBottomColor: 'var(--g1t-line)',
80 editorTabBarBackground: 'var(--g1t-raised)',
81 shadowColor: 'transparent',
82 },
83 },
84 },
85 logo: { src: '@g1t/theme/mark.svg', alt: '' },
86 favicon: '/favicon.svg',
87 customCss: [
88 '@g1t/theme/fonts.css',
89 '@g1t/theme/tokens.css',
90 './src/styles/light.css',
91 './src/styles/g1t.css',
92 ],
93 editLink: {
94 baseUrl: 'https://g1t.sh/flagon-io/g1t/blob/main/apps/docs/',
95 },
96 lastUpdated: true,
97 head: [
98 { tag: 'link', attrs: { rel: 'icon', href: '/favicon.ico', sizes: '32x32' } },
99 { tag: 'link', attrs: { rel: 'icon', type: 'image/png', sizes: '192x192', href: '/icon-192.png' } },
100 { tag: 'link', attrs: { rel: 'icon', type: 'image/png', sizes: '512x512', href: '/icon-512.png' } },
101 { tag: 'link', attrs: { rel: 'apple-touch-icon', sizes: '180x180', href: '/apple-touch-icon.png' } },
102 { tag: 'link', attrs: { rel: 'manifest', href: '/site.webmanifest' } },
103 // The browser's own bars, in the page's colour for the system's setting.
104 { tag: 'meta', attrs: { name: 'theme-color', content: '#0f0f11', media: '(prefers-color-scheme: dark)' } },
105 { tag: 'meta', attrs: { name: 'theme-color', content: '#fbfbfa', media: '(prefers-color-scheme: light)' } },
106 ],
107 sidebar: [
108 {
109 label: 'Get started',
110 items: [
111 { label: 'Quickstart', slug: 'quickstart' },
112 { label: 'How g1t works', slug: 'concepts/overview' },
113 { label: 'The g1t CLI', slug: 'guides/cli' },
114 { label: 'Home', slug: 'guides/home' },
115 { label: 'Work items', slug: 'guides/work-items' },
116 { label: 'Ask g1t', slug: 'guides/ask' },
117 { label: 'AI providers', slug: 'guides/ai' },
118 { label: 'Notifications', slug: 'guides/notifications' },
119 { label: 'The desktop app', slug: 'guides/desktop' },
120 { label: 'The phone app', slug: 'guides/mobile' },
121 { label: 'Search and Explore', slug: 'guides/search' },
122 { label: 'Status and incidents', slug: 'guides/status' },
123 ],
124 },
125 {
126 label: 'Chat',
127 items: [
128 { label: 'Chat', slug: 'guides/chat' },
129 { label: 'Artifacts', slug: 'guides/artifacts' },
130 ],
131 },
132 {
133 label: 'Projects',
134 items: [
135 { label: 'Projects', slug: 'guides/projects' },
136 { label: 'Deployments', slug: 'guides/deployments' },
137 { label: 'Deployments API', slug: 'guides/deployments-api' },
138 { label: 'Observability', slug: 'guides/observability' },
139 { label: 'Packages', slug: 'guides/packages' },
140 { label: 'Container images', slug: 'guides/containers' },
141 { label: 'npm', slug: 'guides/npm' },
142 { label: 'Cargo', slug: 'guides/cargo' },
143 { label: 'Composer', slug: 'guides/composer' },
144 { label: 'Maven', slug: 'guides/maven' },
145 { label: 'NuGet', slug: 'guides/nuget' },
146 { label: 'RubyGems', slug: 'guides/rubygems' },
147 { label: 'Go modules', slug: 'guides/go' },
148 { label: 'Secrets and variables', slug: 'guides/secrets-and-variables' },
149 ],
150 },
151 {
152 label: 'Security',
153 items: [
154 { label: 'Security', slug: 'guides/security' },
155 { label: 'Dependency updates', slug: 'guides/dependency-updates' },
156 { label: 'Secret protection', slug: 'guides/security/secret-protection' },
157 { label: 'Code scanning', slug: 'guides/security/code-scanning' },
158 { label: 'Supply chain', slug: 'guides/security/supply-chain' },
159 { label: 'Advisories and reporting', slug: 'guides/security/advisories' },
160 { label: 'Security overview', slug: 'guides/security/security-overview' },
161 { label: "What's free and what's paid", slug: 'guides/security/pricing' },
162 ],
163 },
164 {
165 label: 'Coding agents',
166 items: [
167 { label: 'Connect a coding agent', slug: 'guides/bring-your-own-agent' },
168 { label: 'Build and ship an app with an agent', slug: 'guides/build-and-ship' },
169 { label: 'Claude Code plugin', slug: 'guides/claude-code-plugin' },
170 { label: 'Sessions, claims and dependencies', slug: 'guides/sessions' },
171 { label: 'Sessions and why-blame', slug: 'guides/why-blame' },
172 ],
173 },
174 {
175 label: 'Connect your tools',
176 items: [
177 { label: 'Integrations', slug: 'guides/integrations' },
178 { label: 'Webhooks', slug: 'guides/webhooks' },
179 { label: 'GitHub Actions', slug: 'guides/actions' },
180 { label: 'Self-hosted runners', slug: 'guides/self-hosted-runners' },
181 { label: 'Guardrails', slug: 'guides/guardrails' },
182 ],
183 },
184 {
185 label: 'Landing changes',
186 items: [
187 { label: 'Pull requests and checks', slug: 'guides/pull-requests' },
188 { label: 'Checks', slug: 'guides/checks' },
189 { label: 'Pull requests into other branches', slug: 'guides/base-branches' },
190 { label: 'Labels', slug: 'guides/labels' },
191 { label: 'Milestones', slug: 'guides/milestones' },
192 { label: 'The merge queue', slug: 'guides/merge-queue' },
193 { label: 'Rules', slug: 'guides/rules' },
194 { label: 'CODEOWNERS', slug: 'guides/codeowners' },
195 { label: 'Forks and working copies', slug: 'concepts/forks' },
196 ],
197 },
198 {
199 label: 'Workspaces',
200 items: [
201 { label: 'Accounts and sign-in', slug: 'guides/authentication' },
202 { label: 'GitHub', slug: 'guides/github' },
203 { label: 'Workspaces and tokens', slug: 'guides/workspaces' },
204 { label: 'Access and roles', slug: 'guides/access-and-roles' },
205 { label: 'Permissions', slug: 'guides/permissions' },
206 { label: 'Single sign-on', slug: 'guides/single-sign-on' },
207 { label: 'Teams', slug: 'guides/teams' },
208 { label: 'People and teams', slug: 'guides/people-and-teams' },
209 { label: 'Managing a repository', slug: 'guides/managing-repositories' },
210 { label: 'Releases', slug: 'guides/releases' },
211 { label: 'Forking a repository', slug: 'guides/forking-repositories' },
212 { label: 'Transferring a repository', slug: 'guides/transferring-repositories' },
213 { label: 'Audit log', slug: 'guides/audit-log' },
214 { label: 'Usage and billing', slug: 'guides/usage-and-billing' },
215 { label: 'Git', slug: 'guides/git' },
216 ],
217 },
218 {
219 label: 'Run g1t yourself',
220 items: [
221 { label: 'With Docker Compose', slug: 'guides/self-hosting' },
222 { label: 'How a self-hosted g1t runs', slug: 'guides/self-hosting-architecture' },
223 { label: 'Deploy to Cloudflare', slug: 'guides/deploy-to-cloudflare' },
224 ],
225 },
226 {
227 label: 'Architecture',
228 items: [
229 { label: 'Overview', slug: 'architecture/overview' },
230 { label: 'How a request is served', slug: 'architecture/requests' },
231 { label: 'Services and contracts', slug: 'architecture/services' },
232 { label: 'Git', slug: 'architecture/git' },
233 { label: 'Events', slug: 'architecture/events' },
234 { label: 'Work and the merge queue', slug: 'architecture/work' },
235 { label: 'Actions, runners and sandboxes', slug: 'architecture/compute' },
236 { label: 'Deployments and telemetry', slug: 'architecture/deployments' },
237 { label: 'Data and storage', slug: 'architecture/data' },
238 { label: 'Identity and access', slug: 'architecture/identity' },
239 { label: 'How g1t ships', slug: 'architecture/shipping' },
240 ],
241 },
242 {
243 label: 'Reference',
244 items: [
245 { label: 'API overview', slug: 'reference/api' },
246 { label: 'MCP tools', slug: 'reference/mcp' },
247 { label: 'CLI commands', slug: 'reference/cli' },
248 { label: 'Developer resources', slug: 'reference/developers' },
249 { label: 'Versioning policy', slug: 'reference/versioning' },
250 { label: 'Rate limits', slug: 'reference/rate-limits' },
251 { label: 'Try it in the explorer', link: '/api/reference/', attrs: { target: '_self' } },
252 { label: 'OpenAPI document', link: 'https://api.g1t.sh/openapi.json' },
253 { label: 'llms.txt', link: 'https://g1t.sh/llms.txt' },
254 ],
255 },
256 {
257 label: 'About',
258 items: [
259 { label: "What g1t can't do yet", slug: 'about/limitations' },
260 { label: 'Issues became work items', slug: 'about/issues-became-work-items' },
261 { label: 'An open letter to Cloudflare', slug: 'about/open-letter-to-cloudflare' },
262 ],
263 },
264 ...apiGroups,
265 ],
266 }),
267 ],
268});