Files

Data Warrior 03db6efeb8 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.

2025-11-11 11:38:44 -07:00

2.5 KiB

Raw Blame History

Phase 0 Gitea Updates Summary

Date: 2025-01-27
Purpose: Document updates made to Phase 0 files to reflect Gitea (self-hosted) instead of GitHub

Changes Made

1. `.cursorrules` File Updates

Updated References:

"GitHub Actions workflows" → "Gitea Actions workflows" (3 occurrences)
"GitHub Actions will auto-update" → "Gitea Actions will auto-update"

Note: Gitea Actions is compatible with GitHub Actions, so the .github/workflows/ directory structure and YAML format remain the same.

2. `docs/AGENT-GUIDELINES.md` Updates

Updated References:

"GitHub issues" → "Gitea issues"
"GitHub Automation" → "Gitea Automation" (section title)
"GitHub Actions workflows" → "Gitea Actions workflows (compatible with GitHub Actions format)"
"When Modifying GitHub Workflows" → "When Modifying Gitea Actions Workflows"
Added note: "Gitea Actions is compatible with GitHub Actions, so workflows use the same YAML format and .github/ directory structure."
Added note: "Gitea Actions workflows use the same YAML format as GitHub Actions, so existing GitHub Actions workflows can be used with minimal or no modifications."
"GitHub automation" → "Gitea automation" (in Getting Help section)

Key Points

Gitea Actions Compatibility: Gitea Actions is compatible with GitHub Actions, meaning:
- Same .github/workflows/ directory structure
- Same YAML workflow format
- Same triggers and syntax
- Existing GitHub Actions workflows can be used with minimal or no modifications
Repository Context:
- Primary repository: https://git.parkingmeter.info/Mycelium/tendril (Gitea)
- Self-hosted Gitea instance
- Uses Gitea Actions for CI/CD automation
No Structural Changes Needed:
- Directory structure remains the same
- Workflow files will work as-is
- Only documentation references needed updating

Files Modified

.cursorrules - Updated 3 references from GitHub to Gitea
docs/AGENT-GUIDELINES.md - Updated 6 references and added compatibility notes

Next Steps

When creating workflows in Phase 3:

Use standard GitHub Actions YAML format
Workflows will work with Gitea Actions automatically
Reference "Gitea Actions" in documentation, but note GitHub Actions compatibility
Test workflows in Gitea Actions interface (similar to GitHub Actions tab)

Location: kb/_guides/PROJECT-SETUP-GUIDE/PHASE-0-GITEA-UPDATES.md
Related: Phase 0 setup, Gitea Actions compatibility

2.5 KiB Raw Blame History