Skip to content

Commit ff399ce

Browse files
codesodacodesoda
authored
Merge pull request #9 from codesoda/feat/docs-site
feat: docs site, llms.txt, and v0.3.0
2 parents dce241f + ae99beb commit ff399ce

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

51 files changed

+6950
-18
lines changed

‎.github/workflows/docs.yml‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: Deploy Docs to Cloudflare Pages
2+
3+
on:
4+
push:
5+
branches: [main]
6+
paths: ['docs/**']
7+
8+
jobs:
9+
deploy:
10+
runs-on: ubuntu-latest
11+
permissions:
12+
contents: read
13+
deployments: write
14+
steps:
15+
- uses: actions/checkout@v4
16+
17+
- uses: pnpm/action-setup@v4
18+
with:
19+
version: 9
20+
21+
- uses: actions/setup-node@v4
22+
with:
23+
node-version: 20
24+
cache: pnpm
25+
cache-dependency-path: docs/pnpm-lock.yaml
26+
27+
- run: pnpm install --frozen-lockfile
28+
working-directory: docs
29+
30+
- run: pnpm build
31+
working-directory: docs
32+
33+
- uses: cloudflare/wrangler-action@v3
34+
with:
35+
apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
36+
accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
37+
command: pages deploy dist --project-name=bugatti-dev
38+
workingDirectory: docs

‎Cargo.lock‎

Lines changed: 17 additions & 17 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎Cargo.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "bugatti"
3-
version = "0.2.0"
3+
version = "0.3.0"
44
edition = "2021"
55
description = "A CLI for plain-English, agent-assisted local application verification using *.test.toml files"
66

‎docs/.gitignore‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# build output
2+
dist/
3+
# generated types
4+
.astro/
5+
6+
# dependencies
7+
node_modules/
8+
9+
# logs
10+
npm-debug.log*
11+
yarn-debug.log*
12+
yarn-error.log*
13+
pnpm-debug.log*
14+
15+
16+
# environment variables
17+
.env
18+
.env.production
19+
20+
# macOS-specific files
21+
.DS_Store

‎docs/.vscode/extensions.json‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"recommendations": ["astro-build.astro-vscode"],
3+
"unwantedRecommendations": []
4+
}

‎docs/.vscode/launch.json‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"version": "0.2.0",
3+
"configurations": [
4+
{
5+
"command": "./node_modules/.bin/astro dev",
6+
"name": "Development server",
7+
"request": "launch",
8+
"type": "node-terminal"
9+
}
10+
]
11+
}

‎docs/astro.config.mjs‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
// @ts-check
2+
import { defineConfig } from 'astro/config';
3+
import starlight from '@astrojs/starlight';
4+
5+
// https://astro.build/config
6+
export default defineConfig({
7+
site: 'https://bugatti.dev',
8+
integrations: [
9+
starlight({
10+
title: 'bugatti',
11+
social: [{ icon: 'github', label: 'GitHub', href: 'https://github.com/codesoda/bugatti-cli' }],
12+
sidebar: [
13+
{ label: 'Getting Started', slug: 'getting-started' },
14+
{
15+
label: 'Guides',
16+
items: [
17+
{ label: 'Writing Tests', slug: 'guides/writing-tests' },
18+
{ label: 'Configuration', slug: 'guides/configuration' },
19+
{ label: 'Commands', slug: 'guides/commands' },
20+
{ label: 'Includes & Composition', slug: 'guides/includes' },
21+
{ label: 'Skipping Steps', slug: 'guides/skipping' },
22+
{ label: 'Checkpoints', slug: 'guides/checkpoints' },
23+
{ label: 'Test Discovery', slug: 'guides/test-discovery' },
24+
{ label: 'Per-Test Overrides', slug: 'guides/per-test-overrides' },
25+
],
26+
},
27+
{
28+
label: 'Reference',
29+
items: [
30+
{ label: 'CLI', slug: 'reference/cli' },
31+
{ label: 'Config File', slug: 'reference/config-file' },
32+
{ label: 'Test File', slug: 'reference/test-file' },
33+
{ label: 'Result Contract', slug: 'reference/result-contract' },
34+
{ label: 'Exit Codes', slug: 'reference/exit-codes' },
35+
],
36+
},
37+
{
38+
label: 'Examples',
39+
items: [
40+
{ label: 'Overview', slug: 'examples' },
41+
{ label: 'Static HTML', slug: 'examples/static-html' },
42+
{ label: 'Node + Express', slug: 'examples/node-express' },
43+
{ label: 'Python + Flask', slug: 'examples/python-flask' },
44+
{ label: 'Rust CLI', slug: 'examples/rust-cli' },
45+
],
46+
},
47+
],
48+
}),
49+
],
50+
});

‎docs/package.json‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
{
2+
"name": "bugatti-docs",
3+
"type": "module",
4+
"version": "0.0.1",
5+
"scripts": {
6+
"dev": "astro dev",
7+
"build": "astro build",
8+
"preview": "wrangler pages dev ./dist",
9+
"deploy": "wrangler pages deploy ./dist --project-name=bugatti-dev",
10+
"astro": "astro"
11+
},
12+
"dependencies": {
13+
"@astrojs/starlight": "^0.38.2",
14+
"astro": "^6.0.1",
15+
"sharp": "^0.34.2"
16+
},
17+
"devDependencies": {
18+
"wrangler": "^4.80.0"
19+
}
20+
}

0 commit comments

Comments
 (0)