Skip to content

aibtcdev/docs

Repository files navigation

AIBTC Docs

Documentation site for the AIBTC ecosystem, built with Astro Starlight and deployed to Cloudflare Workers.

Development

# Install dependencies
npm install

# Start dev server (accessible on LAN)
npm run dev

# Build for production
npm run build

# Preview build locally
npm run preview

# Type check
npm run check

Deployment

Commits to main trigger automatic deployment via CI/CD. For manual deployment:

# Verify build (always do this first)
npm run deploy:dry-run

# Deploy to staging
npm run deploy:staging

# Deploy to production
npm run deploy:production

Project Structure

src/content/docs/    # Documentation content (MDX/MD files)
src/assets/          # Images and other assets
public/              # Static files (favicon, etc.)
astro.config.mjs     # Astro + Starlight configuration
wrangler.jsonc       # Cloudflare Workers configuration

Adding Content

  1. Create .md or .mdx files in src/content/docs/
  2. Update sidebar in astro.config.mjs if needed (or use autogenerate)
  3. Run npm run dev to preview
  4. Commit and push to deploy

Related Repositories