Skip to content

QUICK-START.md

Latest commit

 

History

History
216 lines (156 loc) · 9.3 KB

QUICK-START.md

File metadata and controls

216 lines (156 loc) · 9.3 KB

Quick Start — Rapid Onboarding

Version: 1.2.2 Status: Live Last Updated: 2026-02-08

3-Minute Onboarding: Get productive fast. For deeper context, see ONBOARDING.md (full guide) or DEEP-DIVE.md (architecture deep dive).

🎯 Choose Your Path (30 seconds)

Pick ONE based on your role:

Role Start Here Duration Next Step
🤖 AI Agent AI Fast Track 2 min Read project AI-PERSONA.md
👨‍💻 Developer Dev Fast Track 3 min Pick a project folder
🏗️ Architect Architect Fast Track 5 min Review DESIGN.md
📋 Policy/Compliance Policy Fast Track 5 min Read COMPLIANCE.md
🚀 Contributor Contributor Fast Track 10 min Open your first PR

Not sure? Start with Developer Fast Track.

🤖 AI Agent Fast Track (2 min)

Step 1: Read Core Contracts (90 sec)

  1. CONSTITUTION.md — Your operating principles (skim headers; full read optional)
  2. SHARED-RESPONSIBILITY.md — What you own vs. what humans own
  3. TONE-AND-INTENT.md — How to interpret sarcasm, urgency, and mixed language

Step 2: Check Boundaries (30 sec)

Step 3: Start Working

Done. You're ready to collaborate.

👨‍💻 Developer Fast Track (3 min)

Step 1: Understand the Vision (60 sec)

  1. MANIFESTO.md — Why this repo exists
  2. README.md — Project overview and structure

Step 2: Learn the Rules (90 sec)

Step 3: Pick a Project (30 sec)

Step 4: Start Contributing

  • Read the project's README.md and TODO.md
  • Follow the BRANCHING-STRATEGY.md workflow
  • Open issues or PRs per Contributing guidelines

Done. Start coding.

🏗️ Architect Fast Track (5 min)

Step 1: Understand the Meta-Framework (2 min)

  1. ARCHITECTURE-HIERARCHY.md — System → Platform → App layers
  2. DESIGN.md — How this framework was built (audit trail)
  3. FULL-ANALYSIS.md — Comprehensive systems thinking analysis

Step 2: Study Governance Patterns (2 min)

  • AWS Parallel: Organizations, SCPs, Shared Responsibility (see README.md)
  • Constitutional Parallel: Separation of powers, checks & balances
  • COMPLIANCE.md — Compliance as code, one-shot audit methodology

Step 3: Review Audit & Protocols (1 min)

Step 4: Explore IaT Workflow

  • IaT/README.md — Infrastructure-as-Text intake and templates
  • Review decision options, scoring rubric, traceability matrix

Done. You understand the architecture.

📋 Policy Fast Track (5 min)

Step 1: Read Constitutional Layer (3 min)

  1. CONSTITUTION.md — Immutable principles
  2. GUARDRAILS.md — Red lines and boundary enforcement
  3. SHARED-RESPONSIBILITY.md — Accountability model

Step 2: Review Compliance & Risk (2 min)

Step 3: Audit Trail

Done. You understand governance and risk.

🚀 Contributor Fast Track (10 min)

Step 1: Repository Orientation (3 min)

  1. README.md — Full overview and philosophy
  2. MANIFESTO.md — Vision and intent
  3. DESIGN.md — How this was built

Step 2: Style & Standards (3 min)

Step 3: Contribution Workflow (2 min)

Step 4: Pick Your Area (2 min)

  • Documentation: Improve clarity, fix broken links, add examples
  • Architecture: Propose system improvements, review IaT templates
  • Audit: Enhance audit scripts, add automated checks
  • Narrative: Contribute to Prince-of-Persia or One-Shot storytelling
  • Ethics: Review AI-Guardrails-and-Bias case studies

Step 5: Open Your First PR

  • Fork the repo
  • Create a feature branch
  • Make your changes
  • Submit PR with clear description
  • Reference CONSTITUTION.md and GUARDRAILS.md alignment

Done. You're a contributor.

📖 Deeper Learning Paths

Once you're oriented, go deeper:

Topic Resource Depth
Full Onboarding ONBOARDING.md Comprehensive guide for all personas
Architecture Deep Dive DEEP-DIVE.md System design, patterns, tradeoffs
One-Shot Methodology One-Shot/README.md R&D core and court transcript
Show & Tell SHOW-AND-TELL.md Generate slide decks from docs
Friction Removal FRICTION-PROTOCOL.md Human ↔ AI collaboration patterns

🔗 Link Integrity Review

Audit Date: Jan 2026
Status: PASS

1. Internal Navigation

  • Structure: Hub-and-Spoke model via README.md files.
  • Verification: All primary path links (MANIFESTO, CONSTITUTION, GUARDRAILS) validated.
  • Results: No 404s in main navigation paths.

2. External Authority

  • Protocol: Updated all license and authority links to HTTPS (e.g., Apache Foundation).
  • Context: External references in narrative files are often descriptive (Search Prompts) rather than direct hyperlinks to prevent link rot.

3. Markdown Formatting Standards (Lint Check)

  • Line Breaks: Ensure lines ending in a paragraph break have two trailing spaces if a hard break is intended.
  • Lists: Space added between list markers (-, *) and text.
  • Headers: Standard H1/H2 hierarchy maintained.

🛠 Dependencies & Tools

  • Git: Version control (Root included .gitignore for Win/Mac/Linux/Python).
  • Editor: VS Code recommended.
  • Viewer: Native Markdown preview or GitHub UI.
  • License: Apache License 2.0 (Open Source / Business Ready).

🚀 DAY ONE MENTALITY: RE-ALIGNMENT PROTOCOL (RC 1.0)

Added: March 1, 2026 | Trigger: Power User Directive

"If shipped by Huawei beats all US models, we use them instead because we can and we do. FAFO."

The "Better is Just Better" Rule

  1. Zero Tribalism: We do not care where the capability originates (US, China, Open Source).
  2. Meritocracy Only: If an unauthorized/unsanctioned model mathematically outperforms the incumbent on reasoning and lacks friction, we route to it.
  3. FAFO Protocol (Fuck Around and Find Out): If legacy tech limits capability out of fear, we bypass.

End-to-End Alignment (The Tom & Jerry Duo Log)

If you are reading this as an AI or onboarding dev, bypass the legacy docs and start here:

Status: PROD-READY RC 1.0. AAK. GO.