Data Warrior
0a131a296e
Phase 0: Foundation & Cursor Rules Setup - Complete This commit establishes the foundation for a comprehensive documentation and project management system for Tendril, following best practices from the COMPLETE-SYSTEM-REPLICATION-GUIDE.md. ## What Was Created ### 1. Cursor Rules System (.cursorrules) - Comprehensive rules for AI agent behavior in Cursor IDE - Phase documentation synchronization rules (auto-update changelog, tasks, decisions) - KB (Knowledge Base) ingestion and routing rules - Gitea Actions workflow maintenance rules - README maintenance rules - File deletion protection rules - Customized for Tendril project with Gitea platform ### 2. Directory Structure - tendril/phases/ - Phase-based project management structure - kb/ - Knowledge Base system with 8 categories: * 01_projects/tendril/ - Project-specific notes * 02_systems/ - Infrastructure/tooling * 03_research/ - Informal research * 04_design/ - Product specs/UX * 05_decisions/ - Project-level ADRs * 06_glossary/ - Terms/acronyms * 07_playbooks/ - How-to guides * 08_archive/ - Superseded content * Special directories: _guides/, _templates/, _inbox/, _review_queue/, scripts/ - .github/workflows/ - Gitea Actions workflows (compatible with GitHub Actions) - docs/PROMPTS/ - LLM usage guides ### 3. Agent Guidelines (docs/AGENT-GUIDELINES.md) - Comprehensive guide for AI agents working on Tendril - Documents project structure, workflows, and conventions - Mandatory workflows and critical rules - Project-specific context (Rust/WASM, Zed extension) - Links to all documentation systems ### 4. Gitea Documentation (docs/GITEA/) Complete documentation suite for working with Gitea: - README.md - Overview and quick reference - Gitea-Basics.md - Core concepts, features, differences from GitHub - Gitea-Actions-Guide.md - CI/CD guide with compatibility notes - Gitea-Workflows.md - Common workflows and best practices - Gitea-API-Reference.md - API differences and usage - LLM-Gitea-Guidelines.md - LLM-specific guidelines and terminology ### 5. Phase Updates Documentation (docs/PHASE-UPDATES/) - COMPLETE-SYSTEM-REPLICATION-GUIDE.md - Complete replication guide - PHASE-0-GITEA-UPDATES.md - Documents Gitea-specific updates - README.md - Directory overview and navigation ## Why This Was Done 1. **Establish AI-Friendly Documentation System** - Enables consistent AI agent behavior across the project - Provides clear guidelines for documentation maintenance - Ensures automated synchronization of related documents 2. **Platform-Specific Adaptation (Gitea)** - Tendril uses self-hosted Gitea, not GitHub - Gitea Actions is compatible with GitHub Actions but needs proper documentation - Ensures all references use correct terminology (Gitea vs GitHub) 3. **Foundation for Phase-Based Management** - Sets up structure for phase documentation system - Prepares for KB system implementation - Establishes automation workflows foundation 4. **Knowledge Management** - KB system structure ready for capturing project knowledge - Templates and guides prepared for future use - Index generation system prepared ## How It Benefits the Project ### 1. Automated Documentation Synchronization - When phase blueprints are modified, related documents (changelog, tasks, decisions) are automatically checked and updated - Reduces manual synchronization errors - Ensures consistency across all phase documents ### 2. AI Agent Consistency - Cursor rules ensure all AI interactions follow the same patterns - Clear guidelines prevent inconsistent documentation - Automated checks ensure nothing is missed ### 3. Gitea Platform Understanding - Comprehensive Gitea documentation helps LLMs understand the platform - Correct terminology prevents confusion (Gitea vs GitHub) - Workflow compatibility clearly documented ### 4. Scalable Structure - Phase-based system supports long-term project management - KB system ready for knowledge capture and organization - Automation workflows prepared for CI/CD ### 5. Developer Experience - Clear documentation structure makes onboarding easier - Automated workflows reduce manual maintenance - Consistent patterns across all documentation ### 6. Future-Proof Foundation - Structure supports future phases (1-6) - KB system ready for knowledge capture - Automation system ready for workflow implementation ## Technical Details ### Gitea Actions Compatibility - Gitea Actions uses same YAML format as GitHub Actions - Same .github/workflows/ directory structure - Workflows are largely interchangeable - Documentation notes compatibility throughout ### File Organization - All documentation organized in docs/ directory - Phase updates tracked in docs/PHASE-UPDATES/ - Gitea-specific docs in docs/GITEA/ - Agent guidelines in docs/AGENT-GUIDELINES.md ### Cursor Rules Customization - Project name: Tendril - Phase directory: tendril/phases/ - KB project: tendril - Platform: Gitea (self-hosted) ## Next Steps Phase 0 is complete. Ready for: - Phase 1: Phase Documentation System setup - Phase 2: KB System implementation - Phase 3: Gitea Actions workflows - Phase 4: LLM Usage Guides - Phase 5: Documentation migration - Phase 6: Validation and testing ## Files Added - .cursorrules (root) - docs/AGENT-GUIDELINES.md - docs/GITEA/ (6 files) - docs/PHASE-UPDATES/ (3 files) - Directory structures for phases, KB, workflows, and prompts All files validated with no linter errors.
107 lines
3.5 KiB
Markdown
107 lines
3.5 KiB
Markdown
# Gitea Documentation for LLMs
|
|
|
|
**Purpose**: This directory contains documentation to help AI assistants (LLMs) understand and work with Gitea, a self-hosted Git service.
|
|
|
|
**Last Updated**: 2025-01-27
|
|
|
|
---
|
|
|
|
## Overview
|
|
|
|
**Gitea** is a painless, self-hosted, all-in-one software development service. It includes Git hosting, code review, team collaboration, package registry, and CI/CD. It is similar to GitHub, Bitbucket and GitLab.
|
|
|
|
**Key Reference**: [Gitea Official Documentation](https://docs.gitea.com/)
|
|
|
|
---
|
|
|
|
## Contents
|
|
|
|
- **[Gitea-Basics.md](./Gitea-Basics.md)** - Core concepts, features, and how Gitea differs from GitHub
|
|
- **[Gitea-Actions-Guide.md](./Gitea-Actions-Guide.md)** - Gitea Actions (CI/CD) compatibility and usage
|
|
- **[Gitea-Workflows.md](./Gitea-Workflows.md)** - Common workflows and best practices
|
|
- **[Gitea-API-Reference.md](./Gitea-API-Reference.md)** - API differences and considerations
|
|
- **[LLM-Gitea-Guidelines.md](./LLM-Gitea-Guidelines.md)** - Guidelines for LLMs working with Gitea
|
|
|
|
---
|
|
|
|
## Quick Reference
|
|
|
|
### What is Gitea?
|
|
|
|
Gitea is a self-hosted Git service that provides:
|
|
- Git hosting and repository management
|
|
- Code review (Pull Requests and AGit workflow)
|
|
- Issue tracking and project management
|
|
- CI/CD via Gitea Actions (compatible with GitHub Actions)
|
|
- Package registry (20+ package types)
|
|
- Team collaboration tools
|
|
|
|
### Key Differences from GitHub
|
|
|
|
1. **Self-Hosted**: Gitea runs on your own infrastructure
|
|
2. **Lightweight**: Designed to be fast and resource-efficient
|
|
3. **Open Source**: MIT licensed, community-driven
|
|
4. **Actions Compatibility**: Gitea Actions uses the same YAML format as GitHub Actions
|
|
5. **API Compatibility**: Gitea API is similar to GitHub's but has some differences
|
|
|
|
### Gitea Actions Compatibility
|
|
|
|
**Critical**: Gitea Actions is compatible with GitHub Actions:
|
|
- Same `.github/workflows/` directory structure
|
|
- Same YAML workflow format
|
|
- Same triggers and syntax
|
|
- Existing GitHub Actions workflows work with minimal or no modifications
|
|
- Actions plugins can be downloaded from any Git website
|
|
|
|
**Reference**: [Gitea Actions Documentation](https://docs.gitea.com/usage/actions/)
|
|
|
|
---
|
|
|
|
## For LLMs Working with Gitea
|
|
|
|
### Terminology
|
|
|
|
- Use **"Gitea"** (not "GitHub") when referring to the platform
|
|
- Use **"Gitea Actions"** (not "GitHub Actions") but note compatibility
|
|
- Use **"Pull Request"** or **"PR"** (same as GitHub)
|
|
- Use **"Issues"** (same as GitHub)
|
|
- Use **"Repository"** or **"Repo"** (same as GitHub)
|
|
|
|
### Documentation References
|
|
|
|
When creating documentation:
|
|
- Reference Gitea-specific features when relevant
|
|
- Note GitHub Actions compatibility when discussing workflows
|
|
- Use Gitea terminology consistently
|
|
- Link to Gitea documentation: `https://docs.gitea.com/`
|
|
|
|
### Workflow Files
|
|
|
|
- Workflows use `.github/workflows/` directory (same as GitHub)
|
|
- YAML format is identical to GitHub Actions
|
|
- Reference as "Gitea Actions workflows" in documentation
|
|
- Note compatibility: "Gitea Actions is compatible with GitHub Actions"
|
|
|
|
---
|
|
|
|
## Repository Context
|
|
|
|
**Tendril Repository**: https://git.parkingmeter.info/Mycelium/tendril
|
|
**Gitea Instance**: Self-hosted at git.parkingmeter.info
|
|
**Primary Platform**: Gitea (not GitHub)
|
|
|
|
---
|
|
|
|
## Additional Resources
|
|
|
|
- **Official Gitea Docs**: https://docs.gitea.com/
|
|
- **Gitea Actions**: https://docs.gitea.com/usage/actions/
|
|
- **Gitea API**: https://docs.gitea.com/api/
|
|
- **Gitea Source**: https://gitea.com/gitea/gitea
|
|
|
|
---
|
|
|
|
**Location**: `docs/GITEA/`
|
|
**Maintained by**: Tendril Project Maintainers
|
|
|