Skip to content

Commit bbfccf7

Browse files
whoabuddyclaude
whoabuddy
and
claude
committed
feat: initial AIBTC docs site with Astro Starlight
- Astro Starlight documentation site deployed to Cloudflare Workers - Glossary covering x402, Stacks, CAIP, MCP, and ecosystem terms - Index page with core services, repositories, and open contributions - Staging (aibtc.dev) and production (aibtc.com) environments - Dev server configured with --host for LAN access Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
0 parents  commit bbfccf7

16 files changed

Lines changed: 9027 additions & 0 deletions

‎.env.example‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Cloudflare credentials for deployment
2+
# Copy this file to .env and fill in your values
3+
# DO NOT commit .env to version control
4+
5+
CLOUDFLARE_API_TOKEN=your-api-token-here
6+
CLOUDFLARE_ACCOUNT_ID=your-account-id-here

‎.github/workflows/release-please.yml‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: Release Please
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
8+
permissions:
9+
contents: write
10+
pull-requests: write
11+
12+
jobs:
13+
release-please:
14+
runs-on: ubuntu-latest
15+
steps:
16+
- uses: googleapis/release-please-action@v4
17+
with:
18+
release-type: node

‎.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

‎.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+
}

‎.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+
}

‎CLAUDE.md‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# AIBTC Docs
2+
3+
Documentation site for the AIBTC ecosystem, built with Astro Starlight and deployed to Cloudflare Workers.
4+
5+
## Environments
6+
7+
| Environment | Domain | Zone |
8+
|-------------|--------|------|
9+
| Staging | docs.aibtc.dev | aibtc.dev |
10+
| Production | docs.aibtc.com | aibtc.com |
11+
12+
## Development
13+
14+
```bash
15+
# Install dependencies
16+
npm install
17+
18+
# Start dev server
19+
npm run dev
20+
21+
# Build for production
22+
npm run build
23+
24+
# Preview build locally
25+
npm run preview
26+
```
27+
28+
## Deployment
29+
30+
**Do NOT run deploy directly in development.** Use dry-run to verify, then commit and push for CI/CD.
31+
32+
```bash
33+
# Verify build (always do this first)
34+
npm run deploy:dry-run
35+
36+
# Deploy to staging
37+
npm run deploy:staging
38+
39+
# Deploy to production
40+
npm run deploy:production
41+
```
42+
43+
## Project Structure
44+
45+
```
46+
src/content/docs/ # Documentation content (MDX/MD files)
47+
src/assets/ # Images and other assets
48+
public/ # Static files (favicon, etc.)
49+
astro.config.mjs # Astro + Starlight configuration
50+
wrangler.jsonc # Cloudflare Workers configuration
51+
```
52+
53+
## Adding Content
54+
55+
1. Create `.md` or `.mdx` files in `src/content/docs/`
56+
2. Update sidebar in `astro.config.mjs` if needed (or use autogenerate)
57+
3. Run `npm run dev` to preview
58+
4. Commit and push to deploy
59+
60+
## Configuration
61+
62+
- **Site title**: AIBTC Docs (in astro.config.mjs)
63+
- **Base path**: /docs (all pages served under this path)
64+
- **Social links**: GitHub, X (@aibtcdev)

‎README.md‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Starlight Starter Kit: Basics
2+
3+
[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build)
4+
5+
```
6+
npm create astro@latest -- --template starlight
7+
```
8+
9+
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
10+
11+
## 🚀 Project Structure
12+
13+
Inside of your Astro + Starlight project, you'll see the following folders and files:
14+
15+
```
16+
.
17+
├── public/
18+
├── src/
19+
│ ├── assets/
20+
│ ├── content/
21+
│ │ └── docs/
22+
│ └── content.config.ts
23+
├── astro.config.mjs
24+
├── package.json
25+
└── tsconfig.json
26+
```
27+
28+
Starlight looks for `.md` or `.mdx` files in the `src/content/docs/` directory. Each file is exposed as a route based on its file name.
29+
30+
Images can be added to `src/assets/` and embedded in Markdown with a relative link.
31+
32+
Static assets, like favicons, can be placed in the `public/` directory.
33+
34+
## 🧞 Commands
35+
36+
All commands are run from the root of the project, from a terminal:
37+
38+
| Command | Action |
39+
| :------------------------ | :----------------------------------------------- |
40+
| `npm install` | Installs dependencies |
41+
| `npm run dev` | Starts local dev server at `localhost:4321` |
42+
| `npm run build` | Build your production site to `./dist/` |
43+
| `npm run preview` | Preview your build locally, before deploying |
44+
| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
45+
| `npm run astro -- --help` | Get help using the Astro CLI |
46+
47+
## 👀 Want to learn more?
48+
49+
Check out [Starlight’s docs](https://starlight.astro.build/), read [the Astro documentation](https://docs.astro.build), or jump into the [Astro Discord server](https://astro.build/chat).

‎astro.config.mjs‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
// @ts-check
2+
import { defineConfig } from 'astro/config';
3+
import starlight from '@astrojs/starlight';
4+
import cloudflare from '@astrojs/cloudflare';
5+
6+
// https://astro.build/config
7+
export default defineConfig({
8+
site: 'https://docs.aibtc.com',
9+
output: 'static',
10+
adapter: cloudflare({ imageService: 'compile' }),
11+
integrations: [
12+
starlight({
13+
title: 'AIBTC Docs',
14+
social: [
15+
{ icon: 'github', label: 'GitHub', href: 'https://github.com/aibtcdev' },
16+
{ icon: 'x.com', label: 'X', href: 'https://x.com/aibtcdev' },
17+
],
18+
sidebar: [
19+
{ label: 'Glossary', slug: 'glossary' },
20+
{
21+
label: 'Guides',
22+
autogenerate: { directory: 'guides' },
23+
},
24+
{
25+
label: 'Reference',
26+
autogenerate: { directory: 'reference' },
27+
},
28+
],
29+
}),
30+
],
31+
});

0 commit comments

Comments
 (0)