Skip to content

dotAIslash/dotaislash-examples

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

18 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

dotAIslash Logo

πŸ“š VERSA Examples

Real-World .ai/ Folder Configurations

v1.0.0 Released - October 17, 2025

βœ… 10/10 Examples Validated

License Examples Validated Website

Browse Examples Β· VERSA Spec Β· Get Started


🎯 What is this?

Production-ready examples of .ai/ folder configurations for various project types. Clone, adapt, and use in your own repositories.

Every example is:

  • βœ… Validated against VERSA schemas
  • πŸ“ Documented with inline comments
  • πŸ§ͺ Tested with real AI tools
  • 🎨 Practical based on real-world projects

πŸš€ Quick Start

# Clone the examples
git clone https://github.com/dotAIslash/dotaislash-examples.git

# Copy an example to your project
cp -r dotaislash-examples/typescript-project/.ai your-project/

# Or use the CLI
versa init

πŸ“š Examples

🟒 Beginner-Friendly

The absolute basics. Perfect for learning VERSA.

.ai/
β”œβ”€β”€ context.json        # Just the essentials
└── rules/
    └── style.md        # One simple rule
View context.json
{
  "version": "1.0",
  "rules": ["rules/style.md"],
  "settings": {
    "model": "claude-sonnet-4"
  }
}

A good starting point for most projects.

.ai/
β”œβ”€β”€ context.json
β”œβ”€β”€ profiles/
β”‚   └── cursor.json
β”œβ”€β”€ rules/
β”‚   β”œβ”€β”€ style.md
β”‚   └── security.md
└── agents/
    └── code-reviewer.json

🟑 Intermediate

Full-featured TypeScript setup with linting, testing, and documentation agents.

Highlights:

  • TypeScript-specific rules
  • ESLint + Prettier integration
  • Multiple agents (reviewer, documenter, tester)
  • Cursor + Windsurf profiles

Python project with pytest, black, and mypy configuration.

Highlights:

  • Python style guidelines (PEP 8)
  • Type checking rules
  • Testing best practices
  • Virtual environment awareness

Next.js 15 application with React best practices.

Highlights:

  • Server/client component rules
  • Tailwind CSS guidelines
  • API route conventions
  • Performance optimization tips

πŸ”΄ Advanced

Multi-package repository with shared and package-specific configs.

.ai/
β”œβ”€β”€ context.json              # Global config
β”œβ”€β”€ packages/
β”‚   β”œβ”€β”€ frontend/
β”‚   β”‚   └── .ai/              # Package-specific
β”‚   β”‚       └── context.json
β”‚   └── backend/
β”‚       └── .ai/
β”‚           └── context.json
└── tools/
    └── shared-mcp.json

Highlights:

  • Configuration inheritance
  • Workspace-level rules
  • Package-specific overrides
  • Shared tooling

Distributed system with service-specific configurations.

Highlights:

  • Service boundaries
  • API contract enforcement
  • Shared standards
  • Service-specific agents

OSS project with contributor guidelines and issue templates.

Highlights:

  • Contributing rules
  • Code of conduct enforcement
  • Issue/PR templates
  • Documentation requirements

🎯 Use Case Specific

Data science project with Jupyter, pandas, and ML best practices.

Highlights:

  • Notebook guidelines
  • Data validation rules
  • Model documentation
  • Reproducibility checks

REST API with OpenAPI spec and security guidelines.

Highlights:

  • API design patterns
  • Security checklists
  • Error handling standards
  • Documentation requirements

React Native application with platform-specific rules.

Highlights:

  • iOS/Android conventions
  • Performance guidelines
  • Accessibility rules
  • Native module patterns

Enterprise-grade setup with compliance and security.

Highlights:

  • SOC 2 compliance rules
  • Security scanning
  • Audit logging
  • Access control policies

πŸ“– Example Structure

Each example includes:

example-name/
β”œβ”€β”€ README.md                 # Example overview
β”œβ”€β”€ .ai/
β”‚   β”œβ”€β”€ context.json          # Base configuration
β”‚   β”œβ”€β”€ profiles/             # Tool-specific configs
β”‚   β”‚   β”œβ”€β”€ cursor.json
β”‚   β”‚   β”œβ”€β”€ windsurf.json
β”‚   β”‚   └── claude.json
β”‚   β”œβ”€β”€ rules/                # Guidelines
β”‚   β”‚   β”œβ”€β”€ style.md
β”‚   β”‚   β”œβ”€β”€ security.md
β”‚   β”‚   └── architecture.md
β”‚   β”œβ”€β”€ agents/               # Agent definitions
β”‚   β”‚   β”œβ”€β”€ code-reviewer.json
β”‚   β”‚   β”œβ”€β”€ documenter.json
β”‚   β”‚   └── tester.json
β”‚   └── tools/                # MCP servers
β”‚       └── project-tools.json
└── sample-project/           # Example project files
    └── (actual code)

🎨 Customization Guide

1. Choose a Base Example

Pick the example closest to your project type.

2. Copy to Your Project

cp -r dotaislash-examples/typescript-project/.ai your-project/

3. Customize

Edit files to match your needs:

// .ai/context.json
{
  "version": "1.0",
  "rules": [
    "rules/style.md",           // Keep
    "rules/security.md",        // Keep
    "rules/your-custom.md"      // Add your own
  ]
}

4. Validate

cd your-project
versa lint

πŸ§ͺ Testing Examples

All examples are automatically tested:

# Run validation tests
pnpm test

# Test specific example
pnpm test typescript-project

# Generate test report
pnpm test:report

πŸ“Š Example Matrix

Example Language Framework Complexity Best For
minimal Any None 🟒 Simple Learning
quick-start Any None 🟒 Simple Most projects
typescript-project TypeScript Any 🟑 Medium TS apps
python-project Python Any 🟑 Medium Python apps
nextjs-app TypeScript Next.js 🟑 Medium Web apps
monorepo Multi Multi πŸ”΄ Complex Large projects
microservices Multi Multi πŸ”΄ Complex Distributed
enterprise Any Any πŸ”΄ Complex Compliance

πŸŽ“ Learning Path

Beginner

  1. Start with minimal
  2. Explore quick-start
  3. Try typescript-project or python-project

Intermediate

  1. Study nextjs-app for framework integration
  2. Learn open-source best practices
  3. Explore api-server patterns

Advanced

  1. Master monorepo configuration
  2. Understand microservices architecture
  3. Implement enterprise compliance

🀝 Contributing

Help expand our examples!

Ways to Contribute

  • πŸ“ Add Examples - Share your .ai/ configs
  • πŸ› Report Issues - Found a problem? Let us know
  • πŸ’‘ Suggest Use Cases - What examples are missing?
  • πŸ§ͺ Improve Tests - Better validation
  • πŸ“š Write Guides - Help others learn

Adding an Example

# 1. Fork the repository
git clone https://github.com/your-username/dotaislash-examples.git

# 2. Create new example
mkdir my-example
cd my-example

# 3. Add .ai/ folder and README
# 4. Test it
versa lint

# 5. Submit PR
git add .
git commit -m "feat: add my-example configuration"
git push origin main

See CONTRIBUTING.md for guidelines.


πŸ“„ License

MIT Β© dotAIslash

All examples are free to use and modify.


πŸ”— Resources

  • πŸ“– VERSA Spec - Read the specification
  • πŸ”§ CLI Tool - Command-line interface
  • πŸ“ Schemas - JSON Schema definitions
  • πŸ”Œ Adapters - Tool integrations

Real examples from real projects

⭐ Star us on GitHub Β· πŸ’¬ Discussions Β· πŸ› Issues

About

Example VERSA .ai/ configurations for various project types. Clone and adapt for your own repositories.

Topics

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Packages

No packages published