Skip to content

DOCUMENTATION.md

Latest commit

 

History

History
139 lines (101 loc) · 4.68 KB

DOCUMENTATION.md

File metadata and controls

139 lines (101 loc) · 4.68 KB
Raw

OasisWaker Documentation Index

Welcome! This is your guide to all OasisWaker documentation.

🎯 Quick Navigation

For Everyone

For Contributors

For Maintainers

📚 Documentation by Category

🆕 New Vision (v2.0)

These documents define the future of OasisWaker:

Document Purpose
README.md Project overview, updated for v2.0
NEW_ARCHITECTURE.md The vision: Universal Infrastructure Kernel
MIGRATION_PLAN.md How to get from v1.0 to v2.0
MIGRATION_PLAN.md Phased approach (5 phases, 2.5-3 months)

📖 Learning from v1.0

Important lessons from our first attempt:

Document Purpose
LEGACY.md What v1.0.0 was (archived)
CRITIQUE.md Critical review - what went wrong
.trae/archive/CODE_CLEANUP.md Known code issues to avoid

📋 Current Work

Active specifications and planning:

Document Purpose
.trae/specs/project-preparation-phase/ Current phase - Project cleanup
.trae/specs/project-preparation-phase/spec.md Phase spec (PRD)
.trae/specs/project-preparation-phase/tasks.md Task breakdown
.trae/specs/project-preparation-phase/checklist.md Verification checklist

🗃️ Archived Documentation (v1.0 era)

Old documents from v1.0 development:

Document Purpose
.trae/archive/README.md Archive overview
.trae/documents/ Old MVP planning
.trae/docs/ Old architecture docs
.trae/premortem/ Old risk analysis
.trae/specs/oasiswaker-cli/ Old CLI spec
.trae/specs/oasiswaker-security-architecture/ Old security spec

🎨 Design & Assets

Brand and visual design:

Document Purpose
.trae/design/LOGO-DESIGN-SPECIFICATION.md Logo and brand guide
assets/logo/ SVG logo files

📊 Project Status

Current project state:

Document Purpose
PROJECT_STATUS.md Overall project status
PROJECT_RUNNABILITY.md Can you run the code?
CHANGELOG.md Version history

📜 Templates & Guidelines

For contributing:

Document Purpose
CONTRIBUTING.md How to contribute
CODE_OF_CONDUCT.md Community guidelines
LICENSE MIT License

🔍 Quick Start for New Contributors

Step 1: Understand the Vision

  1. Read README.md
  2. Read NEW_ARCHITECTURE.md

Step 2: See What We're Doing Now

  1. Check .trae/specs/project-preparation-phase/
  2. Read the tasks.md

Step 3: Learn from Mistakes

  1. Read CRITIQUE.md
  2. See .trae/archive/CODE_CLEANUP.md

Step 4: Start Contributing

  1. Read CONTRIBUTING.md
  2. Pick a task from the current phase

📅 Current Phase

Phase 0: Project Preparation (In Progress)

  • ✅ Create documentation index
  • Organize and archive old docs
  • Clean up codebase structure
  • Set up monorepo skeleton

See .trae/specs/project-preparation-phase/ for details.

🔗 External Links

📝 Need Help?

  1. Check this index first
  2. Look in relevant category above
  3. Ask in Discord or open a GitHub issue