Contributing to AkiraDocs

Guide to contributing to the AkiraDocs open-source project.

Getting Started

Setup Development Environment

1# Clone repository
2git clone https://github.com/Cloud-Code-AI/akiradocs
3cd akiradocs
4
5# Install dependencies
6npm install
7
8# Start development server
9npm run dev

Contribution Guidelines

Types of Contributions

  • Bug fixes
  • Feature additions
  • Documentation improvements
  • Translation help
  • Issue reporting

Pull Request Process

1. Fork the repository
2. Create feature branch
3. Make changes
4. Submit pull request

Commit Messages

1# Format
2type(scope): description
3
4# Examples
5feat(editor): add new block type
6fix(translation): correct language detection
7docs(api): update authentication guide

Development Guidelines

Code Style

  • Follow existing patterns
  • Use TypeScript
  • Add comments
  • Write tests

Testing

1# Run tests
2npm run test
3
4# Check types
5npm run type-check
6
7# Lint code
8npm run lint

Documentation

Update Docs

1. Edit relevant files
2. Update examples
3. Check links
4. Verify formatting

Create Examples

  • Clear and concise
  • Well-documented
  • Tested
  • Maintainable

Getting Help

  • Join [Discord](https://discord.gg/zvYZukgeH2)
  • Check [Issues](https://github.com/Cloud-Code-AI/akiradocs/issues)
  • Read [Documentation](https://docs.akiradocs.com)