105 lines
3.4 KiB
Markdown
105 lines
3.4 KiB
Markdown
# CLAUDE.md
|
|
|
|
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
|
|
|
|
## Project Overview
|
|
|
|
**Development Hub** is the central orchestration project for Rob's multi-project development ecosystem. It provides tooling to create and manage projects that follow consistent patterns for documentation, repository structure, and AI-assisted development.
|
|
|
|
## Key Scripts
|
|
|
|
### `bin/new-project`
|
|
|
|
Creates a new project in the ecosystem with all the standard setup:
|
|
|
|
```bash
|
|
# Full usage
|
|
new-project myproject --title "My Project" --tagline "Short description"
|
|
|
|
# Interactive mode (prompts for title/tagline)
|
|
new-project myproject
|
|
|
|
# Options
|
|
--title "..." Display title for the project
|
|
--tagline "..." Short description
|
|
--dry-run Show what would happen without making changes
|
|
--skip-gitea Skip Gitea repository creation (for offline use)
|
|
```
|
|
|
|
**What it does:**
|
|
1. Creates Gitea repository via API
|
|
2. Creates local project directory with git
|
|
3. Generates project files from templates (CLAUDE.md, README.md, .gitignore, pyproject.toml)
|
|
4. Sets up documentation symlink to project-docs
|
|
5. Updates build-public-docs.sh to include the new project
|
|
6. Creates initial commit and pushes
|
|
|
|
## Project Structure
|
|
|
|
```
|
|
development-hub/
|
|
├── bin/
|
|
│ └── new-project # Main scaffolding script
|
|
├── templates/
|
|
│ ├── gitignore.template # Python .gitignore with docs exclusion
|
|
│ ├── CLAUDE.md.template # AI context file
|
|
│ ├── README.md.template # Basic README
|
|
│ ├── pyproject.toml.template
|
|
│ ├── overview.md.template # Docs overview
|
|
│ └── updating-documentation.md.template
|
|
├── docs/ # Symlink to project-docs
|
|
├── CLAUDE.md # This file
|
|
├── README.md
|
|
└── .gitignore
|
|
```
|
|
|
|
## Template Placeholders
|
|
|
|
Templates use these placeholders (replaced by sed):
|
|
|
|
- `{{PROJECT_NAME}}` - lowercase project name (e.g., "my-tool")
|
|
- `{{PROJECT_TITLE}}` - display title (e.g., "My Tool")
|
|
- `{{PROJECT_TAGLINE}}` - short description
|
|
- `{{YEAR}}` - current year
|
|
- `{{DATE}}` - creation date
|
|
- `{{GITEA_URL}}` - https://gitea.brrd.tech
|
|
- `{{GITEA_OWNER}}` - rob
|
|
|
|
## Configuration
|
|
|
|
### Gitea API Token
|
|
|
|
The script needs a Gitea API token to create repositories:
|
|
|
|
1. **Environment variable**: `GITEA_TOKEN`
|
|
2. **Config file**: `~/.config/development-hub/gitea-token`
|
|
|
|
To create a token:
|
|
1. Go to https://gitea.brrd.tech/user/settings/applications
|
|
2. Generate a new token with 'repo' scope
|
|
3. The script will prompt and save it automatically
|
|
|
|
## Documentation
|
|
|
|
Documentation lives in the centralized docs system:
|
|
|
|
- **Source**: `~/PycharmProjects/project-docs/docs/projects/development-hub/`
|
|
- **Public URL**: `https://pages.brrd.tech/rob/development-hub/`
|
|
|
|
When updating documentation:
|
|
1. Edit files in `docs/` (the symlink)
|
|
2. Use `public: true` frontmatter for public-facing docs
|
|
3. Run `~/PycharmProjects/project-docs/scripts/build-public-docs.sh development-hub --deploy` to publish
|
|
|
|
## Related Projects
|
|
|
|
This project manages and creates projects in the ecosystem:
|
|
|
|
- **CmdForge** - AI-powered CLI tool builder
|
|
- **CascadingDev** - Cascading Development Framework
|
|
- **Orchestrated Discussions** - AI Discussion Framework
|
|
- **Artifact Editor** - Code Artifact Editor
|
|
- **Ramble** - Voice Note Transcription
|
|
|
|
All projects follow the same documentation pattern and can be created using `new-project`.
|