ReachableCEO
44cdd6eb67
- Move all docs to docs/ directory for clean repo structure - Create LLM-optimized versions (*-LLM.MD) for AI tool consumption - Update cross-references and links for new paths - Maintain both human-readable and machine-optimized versions - Complete documentation system with worklog tracking
65 lines
1.5 KiB
Markdown
65 lines
1.5 KiB
Markdown
# AI AGENT REFERENCE - LLM OPTIMIZED
|
|
|
|
**FOR: Gemini-CLI, Claude, OpenCode, all AI tools**
|
|
|
|
## CRITICAL RULES
|
|
1. NEVER work on `main` branch
|
|
2. NEVER auto-delete feature branches
|
|
3. ALWAYS push before switching branches
|
|
4. Push every 10 commits max
|
|
5. Tag milestones
|
|
6. UPDATE WORKLOGS
|
|
|
|
## COMMANDS
|
|
|
|
**New feature:**
|
|
```bash
|
|
git checkout main && git pull origin main
|
|
git checkout -b feature/name
|
|
```
|
|
|
|
**Before switch:**
|
|
```bash
|
|
git add . && git commit -m "msg"
|
|
git push origin current-branch
|
|
```
|
|
|
|
**Tag milestone:**
|
|
```bash
|
|
git tag -a name -m "description"
|
|
git push origin name
|
|
```
|
|
|
|
## BRANCHES
|
|
- `main` - stable, protected
|
|
- `LLMBOOTSTRAP` - initial setup
|
|
- `INTEGRATION-WIP` - auto-merge target
|
|
- `RELEASE` - manual PR target
|
|
- `feature/*` - all development
|
|
|
|
## WORKFLOW
|
|
1. Create feature branch from main
|
|
2. Frequent commits (small, logical)
|
|
3. Push every ~10 commits or before switch
|
|
4. Auto-merge to INTEGRATION-WIP
|
|
5. Manual PR to RELEASE
|
|
6. NEVER delete branches
|
|
|
|
## TAGGING
|
|
**When:** milestone/stage/feature complete
|
|
**Format:** `bootstrap-complete`, `milestone-2025-09-05`, `auth-done`
|
|
**Command:** `git tag -a name -m "desc"`
|
|
|
|
## WORKLOGS
|
|
- **docs/WORKLOG-LLM.md** - status/progress
|
|
- **docs/CURRENTWORK-LLM.md** - detailed notes
|
|
**Pattern:** Start→update status, During→add notes, End→update completion
|
|
|
|
## FILES
|
|
- Human: docs/GIT_WORKFLOW.MD, docs/AGENT.MD, docs/WORKLOG.md, docs/CURRENTWORK.md
|
|
- LLM: docs/*-LLM.MD (this file and others)
|
|
|
|
## CONTEXT
|
|
- Platform: Gitea (not GitHub)
|
|
- Repo: /home/localuser/UKSRS/CTO
|
|
- Keep clean: docs in docs/ directory |