Skip to content

docs: add comprehensive developer guides and architecture documentation#3492

Open
metakai1 wants to merge 16 commits intozer0-os:mainfrom
metakai1:docs/add-guides-documentation
Open

docs: add comprehensive developer guides and architecture documentation#3492
metakai1 wants to merge 16 commits intozer0-os:mainfrom
metakai1:docs/add-guides-documentation

Conversation

@metakai1
Copy link
Copy Markdown

@metakai1 metakai1 commented Jan 9, 2026

Summary

This PR contributes a comprehensive documentation suite to help developers understand and contribute to zOS. The documentation was generated using Claude Code and covers the full depth of the zOS architecture.

What's Included

Architecture & Integration

  • Architecture Overview - Complete Redux-Saga-Normalizr pattern documentation with data flow diagrams, module organization, and design decisions
  • Blockchain Integration Guide - Web3 patterns for wallet connections, transactions, smart contracts, and creator economy features
  • Matrix Integration Guide - Real-time communication patterns, event handling, room management, and encryption

The Hitchhiker's Guide to zOS
A Douglas Adams-inspired educational series for developers learning the codebase:

  • Chapter introductions and core concepts
  • Visual diagrams for Redux-Saga flows and normalization patterns
  • Hands-on workshops for practical learning
  • Pattern library and quick reference materials

New Recruits Onboarding

  • Contribution Guide - Step-by-step path from first PR to feature development
  • Development Workflow - Environment setup, debugging strategies, testing approaches
  • Documentation Index - Suggested learning paths and quick links
  • Agent Implementation Guide - Patterns for building on zOS

Developer Reference

  • Component documentation with TypeScript interfaces and examples
  • Custom hooks guide for Matrix media, Web3 wallets, and optimization patterns

File Structure

docs/guides/
├── architecture-overview.md
├── blockchain-integration.md
├── integration-guide.md
├── developer-reference/
│   ├── components.md
│   └── hooks.md
├── hitchhiker/
│   ├── 00-introduction.md
│   ├── chapters/
│   ├── diagrams/
│   ├── patterns/
│   ├── reference/
│   └── workshops/
└── new-recruits/
    ├── agent-implementation-guide.md
    ├── contribution-guide.md
    ├── development-workflow.md
    └── documentation-index.md

Why This Matters

zOS is a sophisticated codebase with advanced patterns that can be challenging for new contributors. This documentation:

  • Lowers the barrier to entry for new developers
  • Explains the "why" behind architectural decisions
  • Provides practical, hands-on learning materials
  • Makes the codebase more accessible without dumbing it down

Test Plan

  • All markdown files render correctly
  • Internal links use relative paths
  • Code examples are syntactically correct

🤖 Generated with Claude Code

metakai1 and others added 16 commits July 31, 2025 08:53
…egin analyzing Chapter 1 (The Redux Galaxy).
…laxy, transforming the technical

  patterns into an engaging narrative.
- Updated all references from forkai/ to new-recruits/ across documentation
- Generalized personal references to be inclusive of all new developers
- Updated 8 files with path and reference changes
- Maintains welcoming tone while being more inclusive
…three of these technologies together in harmony, like a well-rehearsed orchestra playing a symphony of modern web development. Don't panic. This is exactly where you want to be.
You're about to explore zOS - a production application that uses all three of these technologies together in harmony, like a well-rehearsed orchestra playing a symphony of modern web development. Don't panic. This is exactly where you want to be.
Reorganize documentation by moving opusdocs directory contents
to docs/guides for better discoverability and consistent structure.

Includes:
- Architecture overview
- Blockchain integration guide
- Developer reference (components, hooks)
- Hitchhiker's guide series with diagrams and workshops
- New recruits onboarding materials
- Integration guide

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@vercel
Copy link
Copy Markdown

vercel bot commented Jan 9, 2026

@metakai1 is attempting to deploy a commit to the ZERO CORE Team on Vercel.

A member of the Team first needs to authorize it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant