README.md

ONE Platform Documentation

Curated documentation for building AI-native applications on with ONE.

Repository Structure

This repository aggregates documentation from multiple upstream sources to provide a comprehensive reference for ONE platform development.

docs/
├── ai-sdk/          # Vercel AI SDK documentation
├── astro/           # Astro framework documentation
├── claude-code/     # Claude Code CLI documentation
├── convex/          # Convex backend documentation
├── effectts/        # Effect TypeScript documentation
└── sync.sh          # Sync script for upstream updates

Documentation Sources

AI SDK

• Source: https://github.com/vercel/ai
• Purpose: AI SDK for building AI-powered applications
• Topics: Streaming, function calling, tool usage, React hooks

Astro

• Source: https://github.com/withastro/docs
• Purpose: Astro framework documentation
• Topics: Static site generation, islands architecture, integrations

Claude Code

• Source: Native ONE documentation
• Purpose: Claude Code CLI reference
• Topics: Commands, workflows, MCP servers, hooks, plugins

Convex

• Source: https://github.com/get-convex/convex-backend
• Purpose: Convex real-time database documentation
• Topics: Queries, mutations, actions, schema, authentication

Effect TypeScript

• Source: https://github.com/Effect-TS/website
• Purpose: Effect TS functional programming library
• Topics: Type-safe error handling, dependency injection, services

Keeping Documentation in Sync

Automatic Sync

Run the sync script to update all documentation sources:

cd /Users/toc/Server/ONE/docs
./sync.sh

This will:

1. Pull latest changes from all upstream repositories
2. Log sync results and any conflicts
3. Push updates to the ONE docs repository

Manual Sync

Update individual documentation sources:

# AI SDK
cd ai-sdk && git pull origin main

# Astro
cd astro && git pull origin main

# Convex
cd convex && git pull origin main

# Effect TS
cd effectts && git pull origin main

Scheduled Sync (Recommended)

Set up a cron job to sync weekly:

# Edit crontab
crontab -e

# Add weekly sync (every Monday at 9am)
0 9 * * 1 cd /Users/toc/Server/ONE/docs && ./sync.sh >> sync.log 2>&1

Publishing Updates

After syncing upstream changes, publish to GitHub:

cd /Users/toc/Server/ONE/docs

# Review changes
git status

# Commit and push
git add -A
git commit -m "docs: sync upstream documentation sources"
git push origin main

Usage

For ONE Platform Development

Reference these docs when building on ONE:

1. Backend Development → convex/ and effectts/
2. Frontend Development → astro/ and ai-sdk/
3. AI Features → ai-sdk/ and claude-code/
4. CLI Tools → claude-code/

For AI Agents (Claude Code)

These documents are indexed for semantic search and can be referenced by AI agents:

# Claude Code can reference these docs automatically
claude code "How do I set up Convex authentication?"

# The agent will search across all documentation sources

For Developers

Browse documentation directly on GitHub:

• https://github.com/one-ie/docs

Or clone locally for offline access:

git clone https://github.com/one-ie/docs.git
cd docs

File Organization

Each subdirectory maintains its original structure from upstream:

• ai-sdk/docs/ - Main AI SDK documentation
• astro/*.mdx - Astro guides and reference
• claude-code/*.md - Claude Code documentation
• convex/docs/ - Convex documentation
• effectts/content/docs/ - Effect TS guides

Contributing

Adding New Documentation Sources

1. Clone the upstream repository:

   cd /Users/toc/Server/ONE/docs
   git clone --filter=blob:none https://github.com/org/repo.git new-source

2. Update this README with the new source

3. Update sync.sh to include the new source

4. Commit changes:

   git add -A
   git commit -m "docs: add new-source documentation"
   git push origin main

Updating Claude Code Documentation

Claude Code docs are maintained directly in this repository:

cd /Users/toc/Server/ONE/docs/claude-code
# Edit markdown files
git add -A
git commit -m "docs: update claude-code documentation"
git push origin main

Git Configuration

Upstream Remotes

Each subdirectory tracks its upstream source:

# Check upstream remotes
cd ai-sdk && git remote -v      # vercel/ai
cd astro && git remote -v       # withastro/docs
cd convex && git remote -v      # get-convex/convex-backend
cd effectts && git remote -v    # Effect-TS/website

Sparse Checkouts

Some repositories use sparse checkouts (blob:none) to reduce clone size:

# Convert to sparse checkout if needed
git clone --filter=blob:none https://github.com/org/repo.git

License

Each subdirectory maintains its original license from the upstream source. Please review individual LICENSE files before using content.

Links

• ONE Platform: https://one.ie
• GitHub: https://github.com/one-ie/docs
• Main Codebase: https://github.com/one-ie/one

---

Built for the ONE - Bring your ideas to life https://one.ie