docs(phases): add Phase 3-6 plans and update Phase 2 plan
This commit adds comprehensive plan documents for all remaining phases of the project setup system replication: ## Phase Plans Added ### Phase 2 Plan (Updated) - KB System Setup plan document - Already implemented in previous commit - Plan document now tracked in repository ### Phase 3 Plan (New) - Gitea Actions Workflows Setup - Covers .github/ documentation and workflow creation - KB lint and KB index update workflows - Customized for Tendril and Gitea platform ### Phase 4 Plan (New) - LLM Usage Guides Setup - LLM-Usage-Guide.md and Prompt-Creation-Guide.md - Initial prompt documents - Customized for Tendril project ### Phase 5 Plan (New) - Validation and Testing - Comprehensive testing procedures - Test scenarios for all system components - Troubleshooting guide ### Phase 6 Plan (New) - Customization and Final Verification - Project name and terminology verification - Directory structure verification - Final documentation review - System integration verification ## Plan Structure All plans follow consistent structure: - Overview and current state - Detailed task breakdown - Customizations for Tendril - Files to create - Dependencies and success criteria - Validation checklists - Notes and references ## Customizations All plans are customized for: - Tendril project (not "pairs") - Gitea platform (not GitHub) - Tendril-specific directory structure - Gitea Actions (with GitHub Actions compatibility notes) ## Files Added - kb/_guides/PROJECT-SETUP-GUIDE/PHASE-2-PLAN.md (5.0KB) - kb/_guides/PROJECT-SETUP-GUIDE/PHASE-3-PLAN.md (13KB) - kb/_guides/PROJECT-SETUP-GUIDE/PHASE-4-PLAN.md (8.1KB) - kb/_guides/PROJECT-SETUP-GUIDE/PHASE-5-PLAN.md (12KB) - kb/_guides/PROJECT-SETUP-GUIDE/PHASE-6-PLAN.md (11KB) Total: 5 phase plan documents, ~49KB of planning documentation
This commit is contained in:
143
kb/_guides/PROJECT-SETUP-GUIDE/PHASE-2-PLAN.md
Normal file
143
kb/_guides/PROJECT-SETUP-GUIDE/PHASE-2-PLAN.md
Normal file
@@ -0,0 +1,143 @@
|
||||
# Gitea Documentation Integration and GitHub Reference Cleanup
|
||||
|
||||
## Objective
|
||||
|
||||
Update `.cursorrules` and related documentation to:
|
||||
|
||||
1. Add references to Gitea documentation (`docs/GITEA/`)
|
||||
2. Ensure all platform references correctly use "Gitea" (not "GitHub")
|
||||
3. Add guidance to consult Gitea documentation when working with Gitea-specific features
|
||||
4. Verify all compatibility notes are clear (Gitea Actions is compatible with GitHub Actions format)
|
||||
|
||||
## Current State Analysis
|
||||
|
||||
### .cursorrules File
|
||||
|
||||
- ✅ Already uses "Gitea Actions" (correct)
|
||||
- ✅ References `.github/` directory (correct - that's the actual directory name)
|
||||
- ❌ Missing: References to Gitea documentation
|
||||
- ❌ Missing: Guidance to consult Gitea docs when working with workflows
|
||||
- ❌ Missing: Reference to repository URL (https://git.parkingmeter.info/Mycelium/tendril)
|
||||
|
||||
### Documentation Files
|
||||
|
||||
- ✅ `docs/GITEA/` - Comprehensive Gitea documentation exists
|
||||
- ✅ Most references correctly note "compatible with GitHub Actions"
|
||||
- ⚠️ Some references may need clarification
|
||||
- ✅ `docs/AGENT-GUIDELINES.md` - Already updated for Gitea
|
||||
|
||||
## Tasks
|
||||
|
||||
### Task 1: Update .cursorrules with Gitea Documentation References
|
||||
|
||||
**Location**: `.cursorrules`
|
||||
|
||||
**Changes Needed**:
|
||||
|
||||
1. Add section referencing Gitea documentation:
|
||||
|
||||
- Reference `docs/GITEA/` for Gitea-specific guidance
|
||||
- Reference `docs/GITEA/LLM-Gitea-Guidelines.md` for LLM-specific guidelines
|
||||
- Reference `docs/GITEA/Gitea-Actions-Guide.md` when working with workflows
|
||||
|
||||
2. Add repository context:
|
||||
|
||||
- Repository: https://git.parkingmeter.info/Mycelium/tendril
|
||||
- Platform: Gitea (self-hosted)
|
||||
|
||||
3. Update General Project Rules section:
|
||||
|
||||
- Add reference to Gitea documentation
|
||||
- Note to consult Gitea docs for platform-specific questions
|
||||
|
||||
4. Update workflow maintenance rules:
|
||||
|
||||
- Reference `docs/GITEA/Gitea-Actions-Guide.md`
|
||||
- Note Gitea Actions compatibility
|
||||
|
||||
### Task 2: Review and Update Other Documentation Files
|
||||
|
||||
**Files to Check**:
|
||||
|
||||
- `docs/AGENT-GUIDELINES.md` - Verify Gitea references are correct
|
||||
- `docs/PHASE-UPDATES/README.md` - Check for any GitHub references
|
||||
- `PHASE-1-PLAN.md` - Update if needed
|
||||
|
||||
**Action**: Ensure all references correctly use "Gitea" terminology and link to Gitea documentation where appropriate.
|
||||
|
||||
### Task 3: Add Gitea Platform Context Section
|
||||
|
||||
**Location**: `.cursorrules` (new section)
|
||||
|
||||
**Content**:
|
||||
|
||||
- Repository URL and platform information
|
||||
- Reference to Gitea documentation
|
||||
- Note about Gitea Actions compatibility
|
||||
- Guidance on when to consult Gitea docs
|
||||
|
||||
## Implementation Details
|
||||
|
||||
### .cursorrules Updates
|
||||
|
||||
**Add new section after "General Project Rules"**:
|
||||
|
||||
```markdown
|
||||
## Gitea Platform Context
|
||||
|
||||
**Repository**: https://git.parkingmeter.info/Mycelium/tendril
|
||||
**Platform**: Gitea (self-hosted)
|
||||
**Actions System**: Gitea Actions (compatible with GitHub Actions format)
|
||||
|
||||
### Gitea Documentation References
|
||||
|
||||
When working with Gitea-specific features, workflows, or platform questions:
|
||||
|
||||
1. **Consult Gitea Documentation**: See `docs/GITEA/` for comprehensive Gitea guidance
|
||||
2. **LLM Guidelines**: See `docs/GITEA/LLM-Gitea-Guidelines.md` for LLM-specific guidelines
|
||||
3. **Actions Guide**: See `docs/GITEA/Gitea-Actions-Guide.md` when working with workflows
|
||||
4. **API Reference**: See `docs/GITEA/Gitea-API-Reference.md` for API differences
|
||||
|
||||
### Platform Terminology
|
||||
|
||||
- Use **"Gitea"** (not "GitHub") when referring to the platform
|
||||
- Use **"Gitea Actions"** (not "GitHub Actions") but note compatibility
|
||||
- Use **"Gitea issues"** (not "GitHub issues")
|
||||
- Use **"Gitea repository"** (not "GitHub repository")
|
||||
- Note: Gitea Actions is compatible with GitHub Actions, so workflows use the same YAML format and `.github/` directory structure
|
||||
```
|
||||
|
||||
**Update "General Project Rules" section**:
|
||||
|
||||
- Add: "Consult `docs/GITEA/` documentation for Gitea-specific guidance"
|
||||
|
||||
**Update workflow maintenance rules**:
|
||||
|
||||
- Add reference to `docs/GITEA/Gitea-Actions-Guide.md`
|
||||
- Note to consult Gitea Actions guide for workflow questions
|
||||
|
||||
## Verification Checklist
|
||||
|
||||
After updates:
|
||||
|
||||
- [ ] `.cursorrules` references Gitea documentation
|
||||
- [ ] `.cursorrules` includes repository URL
|
||||
- [ ] `.cursorrules` includes platform context section
|
||||
- [ ] All "GitHub" references are either:
|
||||
- Updated to "Gitea" (when referring to platform)
|
||||
- Left as-is with compatibility note (when referring to GitHub Actions compatibility)
|
||||
- [ ] All documentation files reviewed
|
||||
- [ ] Links to Gitea documentation are correct
|
||||
- [ ] Terminology is consistent throughout
|
||||
|
||||
## Files to Modify
|
||||
|
||||
1. `.cursorrules` - Add Gitea platform context and documentation references
|
||||
2. Review other docs for any missed GitHub references (if found, update)
|
||||
|
||||
## Expected Outcome
|
||||
|
||||
- `.cursorrules` properly references Gitea platform and documentation
|
||||
- Clear guidance on when to consult Gitea documentation
|
||||
- Consistent terminology throughout (Gitea, not GitHub)
|
||||
- Proper compatibility notes where GitHub Actions format is referenced
|
||||
Reference in New Issue
Block a user