tendril/kb/_guides/PROJECT-SETUP-GUIDE/PHASE-2-PLAN.md

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":

## 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