Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/docs/cli/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,9 @@ ralph-starter config set apiKey sk-ant-xxxx
ralph-starter config set linear.apiKey lin_api_xxxx
ralph-starter config set notion.token secret_xxxx
ralph-starter config set github.token ghp_xxxx

# Set defaults
ralph-starter config set github.defaultIssuesRepo owner/repo
```

### Delete Value
Expand All @@ -70,6 +73,7 @@ ralph-starter config delete linear.apiKey
| `linear.apiKey` | Linear API key |
| `notion.token` | Notion integration token |
| `github.token` | GitHub personal access token |
| `github.defaultIssuesRepo` | Default repo for `--issue` without `--project` |

## Storage Location

Expand Down
70 changes: 70 additions & 0 deletions docs/docs/community/changelog.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
---
sidebar_position: 2
title: Changelog
description: Release notes and version history for ralph-starter
---

# Changelog

All notable changes to ralph-starter are documented here.

## [Unreleased]

### Planned
- Interactive wizard mode improvements
- Additional input source integrations
- Template marketplace

---

## [0.1.x] - Initial Release

### Added
- Core CLI with `run`, `init`, `plan`, `config`, and `source` commands
- GitHub integration for fetching issues and PRs
- Linear integration for fetching issues
- Notion integration for fetching pages
- Interactive wizard with idea mode
- MCP server integration for Claude Desktop
- Ralph Playbook support for custom configurations
- Git automation for commits and PRs
- Validation system for specs

### Features
- **Multi-source support**: Fetch specs from GitHub, Linear, or Notion
- **Autonomous coding loops**: Let AI agents build from specs
- **Interactive wizard**: Step-by-step project setup
- **MCP integration**: Use with Claude Desktop

---

## Version History

For the complete version history and release notes, see:

- [GitHub Releases](https://github.com/rubenmarcus/ralph-starter/releases)
- [npm Package History](https://www.npmjs.com/package/ralph-starter?activeTab=versions)

## Upgrade Guide

### Upgrading to latest

```bash
npm install -g ralph-starter@latest
# or
pnpm add -g ralph-starter@latest
```

### Check current version

```bash
ralph-starter --version
```

## Contributing

Found a bug or want to contribute?

- [Report Issues](https://github.com/rubenmarcus/ralph-starter/issues)
- [Submit Ideas](https://github.com/rubenmarcus/ralph-ideas/issues)
- [View Source](https://github.com/rubenmarcus/ralph-starter)
158 changes: 158 additions & 0 deletions docs/docs/community/contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,158 @@
---
sidebar_position: 3
title: Contributing
description: How to contribute to ralph-starter
---

# Contributing

Thank you for your interest in contributing to ralph-starter! This guide will help you get started.

## Ways to Contribute

### Report Bugs

Found a bug? Please report it on [GitHub Issues](https://github.com/rubenmarcus/ralph-starter/issues).

When reporting bugs, please include:
- ralph-starter version (`ralph-starter --version`)
- Node.js version (`node --version`)
- Operating system
- Steps to reproduce
- Expected vs actual behavior
- Error messages or logs

### Submit Ideas

Have a feature idea? Submit it to [ralph-ideas](https://github.com/rubenmarcus/ralph-ideas/issues).

Good idea submissions include:
- Clear description of the feature
- Use case / problem it solves
- Suggested implementation (optional)
- Examples from other tools (optional)

### Contribute Code

1. **Fork the repository**
```bash
gh repo fork rubenmarcus/ralph-starter
```

2. **Clone your fork**
```bash
git clone https://github.com/YOUR_USERNAME/ralph-starter
cd ralph-starter
```

3. **Install dependencies**
```bash
pnpm install
```

4. **Create a feature branch**
```bash
git checkout -b feature/your-feature-name
```

5. **Make your changes**
- Follow the existing code style
- Add tests for new functionality
- Update documentation if needed

6. **Run tests**
```bash
pnpm test
```

7. **Commit your changes**
```bash
git commit -m "feat: add your feature description"
```

8. **Push and create a PR**
```bash
git push origin feature/your-feature-name
gh pr create
```

## Development Setup

### Prerequisites

- Node.js 18+
- pnpm
- Git

### Project Structure

```
ralph-starter/
├── src/ # Source code
│ ├── cli/ # CLI commands
│ ├── sources/ # Input source integrations
│ ├── core/ # Core functionality
│ └── utils/ # Utility functions
├── docs/ # Documentation (Docusaurus)
├── tests/ # Test files
└── package.json
```

### Running Locally

```bash
# Build the project
pnpm build

# Run in development
pnpm dev

# Run tests
pnpm test

# Run linting
pnpm lint
```

## Code Style

- Use TypeScript
- Follow existing patterns in the codebase
- Use meaningful variable and function names
- Add JSDoc comments for public APIs
- Keep functions small and focused

## Commit Messages

We follow [Conventional Commits](https://www.conventionalcommits.org/):

- `feat:` New feature
- `fix:` Bug fix
- `docs:` Documentation changes
- `chore:` Maintenance tasks
- `refactor:` Code refactoring
- `test:` Adding or updating tests

Examples:
```
feat: add Jira integration
fix: resolve GitHub auth token refresh issue
docs: update installation guide
```

## Pull Request Guidelines

- Keep PRs focused on a single change
- Include tests for new functionality
- Update documentation if needed
- Link to related issues
- Respond to review feedback promptly

## Questions?

- [GitHub Discussions](https://github.com/rubenmarcus/ralph-starter/discussions)
- [Open an Issue](https://github.com/rubenmarcus/ralph-starter/issues)

---

Thank you for contributing to ralph-starter!
118 changes: 118 additions & 0 deletions docs/docs/community/ideas.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
---
sidebar_position: 1
title: Ideas & Roadmap
description: Feature ideas and development roadmap for ralph-starter
---

# Ideas & Roadmap

Browse and contribute to the future of ralph-starter. All ideas and feature requests are tracked in the [ralph-ideas](https://github.com/rubenmarcus/ralph-ideas) repository.

## Quick Links

- [View All Ideas](https://github.com/rubenmarcus/ralph-ideas/issues)
- [Submit New Idea](https://github.com/rubenmarcus/ralph-ideas/issues/new)
- [P1 - Critical Priority](https://github.com/rubenmarcus/ralph-ideas/labels/P1)
- [P2 - High Priority](https://github.com/rubenmarcus/ralph-ideas/labels/P2)
- [P3 - Medium Priority](https://github.com/rubenmarcus/ralph-ideas/labels/P3)

## Categories

### Templates

Pre-built project starters for various use cases:

| Template | Priority | Status |
|----------|----------|--------|
| [Next.js SaaS Starter](https://github.com/rubenmarcus/ralph-ideas/issues?q=label%3Atemplates+saas) | P1 | Planned |
| [Marketing Landing Page](https://github.com/rubenmarcus/ralph-ideas/issues?q=label%3Atemplates+landing) | P1 | Planned |
| [GitHub Actions CI/CD](https://github.com/rubenmarcus/ralph-ideas/issues?q=label%3Adevops+actions) | P1 | Planned |
| [Express.js REST API](https://github.com/rubenmarcus/ralph-ideas/issues?q=label%3Atemplates+express) | P2 | Planned |
| [Chrome Extension](https://github.com/rubenmarcus/ralph-ideas/issues?q=label%3Atemplates+extension) | P2 | Planned |
| [CLI Tool](https://github.com/rubenmarcus/ralph-ideas/issues?q=label%3Atemplates+cli) | P2 | Planned |

[View all templates →](https://github.com/rubenmarcus/ralph-ideas/labels/templates)

### Automation

Tools to streamline development workflows:

| Feature | Priority | Status |
|---------|----------|--------|
| [Auto PR Review Bot](https://github.com/rubenmarcus/ralph-ideas/issues?q=label%3Aautomation+PR+review) | P1 | Planned |
| [Auto Release Notes](https://github.com/rubenmarcus/ralph-ideas/issues?q=label%3Aautomation+release) | P1 | Planned |
| [Auto Issue Triage](https://github.com/rubenmarcus/ralph-ideas/issues?q=label%3Aautomation+triage) | P2 | Planned |
| [Auto Dependency Updates](https://github.com/rubenmarcus/ralph-ideas/issues?q=label%3Aautomation+dependency) | P2 | Planned |
| [Auto Documentation](https://github.com/rubenmarcus/ralph-ideas/issues?q=label%3Aautomation+docs) | P2 | Planned |
| [Auto Test Generator](https://github.com/rubenmarcus/ralph-ideas/issues?q=label%3Aautomation+test) | P2 | Planned |

[View all automation ideas →](https://github.com/rubenmarcus/ralph-ideas/labels/automation)

### Blockchain & Web3

Blockchain and decentralized application templates:

| Template | Priority | Status |
|----------|----------|--------|
| [Web3 dApp Frontend](https://github.com/rubenmarcus/ralph-ideas/issues?q=label%3Ablockchain+dapp) | P2 | Planned |
| [ERC-20 Token](https://github.com/rubenmarcus/ralph-ideas/issues?q=label%3Ablockchain+erc20) | P3 | Backlog |
| [NFT Collection](https://github.com/rubenmarcus/ralph-ideas/issues?q=label%3Ablockchain+nft) | P3 | Backlog |
| [DeFi Staking Contract](https://github.com/rubenmarcus/ralph-ideas/issues?q=label%3Ablockchain+defi) | P3 | Backlog |

[View all blockchain ideas →](https://github.com/rubenmarcus/ralph-ideas/labels/blockchain)

### DevOps & Infrastructure

CI/CD and infrastructure templates:

| Template | Priority | Status |
|----------|----------|--------|
| [Docker Compose Dev Environment](https://github.com/rubenmarcus/ralph-ideas/issues?q=label%3Adevops+docker) | P2 | Planned |
| [Kubernetes + Helm Charts](https://github.com/rubenmarcus/ralph-ideas/issues?q=label%3Adevops+kubernetes) | P3 | Backlog |
| [Terraform Infrastructure](https://github.com/rubenmarcus/ralph-ideas/issues?q=label%3Adevops+terraform) | P3 | Backlog |
| [Monitoring Stack](https://github.com/rubenmarcus/ralph-ideas/issues?q=label%3Adevops+monitoring) | P3 | Backlog |

[View all DevOps ideas →](https://github.com/rubenmarcus/ralph-ideas/labels/devops)

### Scripts & Utilities

Helpful scripts and developer tools:

| Utility | Priority | Status |
|---------|----------|--------|
| [Git Hooks Setup](https://github.com/rubenmarcus/ralph-ideas/issues?q=label%3Ascripts+hooks) | P2 | Planned |
| [Database Seeder](https://github.com/rubenmarcus/ralph-ideas/issues?q=label%3Ascripts+seeder) | P2 | Planned |
| [OpenAPI Client Generator](https://github.com/rubenmarcus/ralph-ideas/issues?q=label%3Ascripts+openapi) | P3 | Backlog |
| [Environment Validator](https://github.com/rubenmarcus/ralph-ideas/issues?q=label%3Ascripts+env) | P3 | Backlog |
| [Project Health Check](https://github.com/rubenmarcus/ralph-ideas/issues?q=label%3Ascripts+health) | P3 | Backlog |

[View all scripts & utilities →](https://github.com/rubenmarcus/ralph-ideas/labels/scripts)

## Integrations

Feature requests for ralph-starter core:

| Feature | Priority | Status |
|---------|----------|--------|
| [Slack Integration](https://github.com/rubenmarcus/ralph-ideas/issues?q=slack) | Enhancement | Planned |
| [Figma Integration](https://github.com/rubenmarcus/ralph-ideas/issues?q=figma) | Enhancement | Planned |
| [Debug/Interactive Mode](https://github.com/rubenmarcus/ralph-ideas/issues?q=debug+mode) | Enhancement | Planned |
| [Swarm Mode](https://github.com/rubenmarcus/ralph-ideas/issues?q=swarm) | Enhancement | Planned |
| [GitHub Action](https://github.com/rubenmarcus/ralph-ideas/issues?q=github+action) | Enhancement | Planned |
| [Ollama Support](https://github.com/rubenmarcus/ralph-ideas/issues?q=ollama) | Enhancement | Planned |
| [Google Gemini Provider](https://github.com/rubenmarcus/ralph-ideas/issues?q=gemini) | Enhancement | Planned |

## Contributing Ideas

Have a feature request or idea? We'd love to hear it!

1. **Check existing issues** - Search [ralph-ideas](https://github.com/rubenmarcus/ralph-ideas/issues) to avoid duplicates
2. **Create a new issue** - Use a clear, descriptive title
3. **Add labels** - Use appropriate priority (P1/P2/P3) and category labels
4. **Describe the use case** - Explain why this feature would be useful

### Priority Guidelines

- **P1 (Critical)**: Core features that many users need
- **P2 (High)**: Important features that enhance the experience
- **P3 (Medium)**: Nice-to-have features for specific use cases
Loading