Files
tendril/kb/_guides/PROJECT-SETUP-GUIDE
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
..

Project Setup Guide

Purpose: This directory contains documentation related to project setup, phase plans, system replication guides, and migration notes.

Last Updated: 2025-01-27


Contents

System Replication

  • COMPLETE-SYSTEM-REPLICATION-GUIDE.md - Comprehensive guide for replicating the PAIRS documentation and automation system in another project. Includes all structures, schemas, templates, rationale, and step-by-step instructions.

Phase Plans and Updates

  • PHASE-0-GITEA-UPDATES.md - Documents updates made to Phase 0 files to reflect Gitea (self-hosted) instead of GitHub. Includes changes to .cursorrules and docs/AGENT-GUIDELINES.md.

  • PHASE-1-PLAN.md - Detailed plan for Phase 1: Phase Documentation System setup. Includes tasks breakdown, customizations for Tendril, and review checklist.


Purpose

This directory serves as a reference for:

  1. System Replication: Complete guide for setting up the documentation and automation system in new projects
  2. Phase Plans: Detailed plans for each phase of project setup
  3. Phase Updates: Tracking changes and updates made during each phase of project setup
  4. Migration Notes: Documenting platform-specific adaptations (e.g., Gitea vs GitHub)

Usage

For System Replication

If you want to replicate this documentation system in another project:

  1. Read COMPLETE-SYSTEM-REPLICATION-GUIDE.md
  2. Follow the step-by-step replication guide
  3. Customize for your project's needs

For Phase Plans and Updates

When planning or updating phases:

  1. Create phase plans in this directory (e.g., PHASE-1-PLAN.md)
  2. Document changes in phase-specific update files (e.g., PHASE-0-GITEA-UPDATES.md)
  3. Reference these files when reviewing phase work
  4. Use as historical record of decisions made

  • Agent Guidelines: docs/AGENT-GUIDELINES.md - Guidelines for AI agents
  • Gitea Documentation: docs/GITEA/ - Gitea-specific documentation
  • Phase Documentation: tendril/phases/ - Phase blueprints and related docs

Location: kb/_guides/PROJECT-SETUP-GUIDE/
Maintained by: Tendril Project Maintainers