docs: reorganize project structure and add Gitea platform context
This commit implements a comprehensive reorganization of project documentation and adds explicit Gitea platform context throughout the project. ## Documentation Reorganization ### File Moves (Content Preserved) - Moved CURSOR_WINDOWS_SETUP.md to kb/_guides/ for better organization - Moved docs/PHASE-UPDATES/ to kb/_guides/PROJECT-SETUP-GUIDE/: - COMPLETE-SYSTEM-REPLICATION-GUIDE.md - PHASE-0-GITEA-UPDATES.md - README.md - Added new file: kb/_guides/PROJECT-SETUP-GUIDE/PHASE-1-PLAN.md **Reason**: Consolidate project setup and configuration guides into the knowledge base structure for better discoverability and organization. ### New Phase Documentation Structure Created tendril/phases/ directory with structured phase documentation: - phase-00-foundation/: blueprint, changelog, decisions, tasks - phase-01-testing-validation/: blueprint, changelog, decisions, tasks **Reason**: Establish consistent phase documentation structure following project guidelines for phase management and tracking. ## Gitea Platform Context Integration ### .cursorrules Updates - Added comprehensive Gitea platform context section - Added Gitea documentation references for workflows and platform questions - Added platform terminology guidelines (Gitea vs GitHub) - Added references to docs/GITEA/ documentation throughout rules **Reason**: Ensure all AI agents and contributors use correct Gitea terminology and have clear guidance on where to find Gitea-specific documentation. ### Documentation Path Updates - CONTRIBUTING.md: Updated CURSOR_WINDOWS_SETUP.md path reference - docs/AGENT-GUIDELINES.md: Updated path references to moved documentation - PROJECT_STATUS.md: Updated comment to mention Gitea Actions **Reason**: Maintain link integrity after file reorganization and ensure documentation references point to correct locations. ## Impact and Benefits 1. **Better Organization**: Documentation is now organized in logical structures (kb/ for knowledge base, tendril/phases/ for phase docs) 2. **Clear Platform Context**: Explicit Gitea platform references prevent confusion with GitHub terminology and provide clear documentation paths 3. **Consistent Structure**: Phase documentation follows standardized format (blueprint, changelog, decisions, tasks) for easier maintenance 4. **Improved Discoverability**: Guides consolidated in kb/_guides/ make it easier to find setup and configuration information All file moves preserve content - no information was lost in this reorganization.
This commit is contained in:
31
.cursorrules
31
.cursorrules
@@ -30,6 +30,8 @@ When ANY file matching `tendril/phases/phase-*/blueprint.md` is edited or update
|
||||
|
||||
#### When Gitea Actions workflows (`.github/workflows/*.yml`) are modified:
|
||||
|
||||
**Reference**: See `docs/GITEA/Gitea-Actions-Guide.md` for Gitea Actions workflow guidance and compatibility notes.
|
||||
|
||||
1. **ALWAYS update `.github/CHANGELOG.md`**:
|
||||
- Document workflow changes, new triggers, or automation updates
|
||||
- Note any changes to scheduled times or conditions
|
||||
@@ -48,6 +50,7 @@ When ANY file matching `tendril/phases/phase-*/blueprint.md` is edited or update
|
||||
4. **ALWAYS verify workflow references**:
|
||||
- Check that documentation references to workflows use correct file names
|
||||
- Ensure workflow descriptions in docs match actual workflow logic
|
||||
- Consult `docs/GITEA/Gitea-Actions-Guide.md` for workflow best practices
|
||||
|
||||
#### When `.github/` folder is modified (any file):
|
||||
|
||||
@@ -116,6 +119,33 @@ When blueprint.md changes include:
|
||||
- Update documentation incrementally, not at the end
|
||||
- Follow the structure defined in `docs/AGENT-GUIDELINES.md`
|
||||
- Use conventional commit messages with phase references
|
||||
- Consult `docs/GITEA/` documentation for Gitea-specific guidance and platform questions
|
||||
|
||||
## 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
|
||||
5. **Workflows Guide**: See `docs/GITEA/Gitea-Workflows.md` for common workflows and best practices
|
||||
6. **Basics Guide**: See `docs/GITEA/Gitea-Basics.md` for core concepts and features
|
||||
|
||||
### Platform Terminology
|
||||
|
||||
- Use **"Gitea"** (not "GitHub") when referring to the platform
|
||||
- Use **"Gitea Actions"** (not "GitHub Actions") but note compatibility when relevant
|
||||
- Use **"Gitea issues"** (not "GitHub issues")
|
||||
- Use **"Gitea repository"** (not "GitHub repository")
|
||||
- Use **"Gitea Runners"** (not "GitHub Runners")
|
||||
- **Note**: Gitea Actions is compatible with GitHub Actions, so workflows use the same YAML format and `.github/` directory structure
|
||||
|
||||
## KB Ingestion & Routing Rules
|
||||
|
||||
@@ -169,6 +199,7 @@ When the chat starts with the text "SYSTEM — KB Ingestion & Routing" (from `/k
|
||||
|
||||
**When KB structure or guidelines change:**
|
||||
- Check and update Gitea Actions workflows (`.github/workflows/kb-lint.yml`) if KB validation rules change
|
||||
- Consult `docs/GITEA/Gitea-Actions-Guide.md` for workflow guidance
|
||||
- Check and update README.md if KB system is added or significantly modified
|
||||
- Ensure workflows stay in sync with KB guidelines in `/kb/_guides/`
|
||||
|
||||
|
||||
Reference in New Issue
Block a user