Skip to content

INDEX.md

Latest commit

 

History

History
253 lines (207 loc) · 14.5 KB

INDEX.md

File metadata and controls

253 lines (207 loc) · 14.5 KB
Raw

HoloLand Documentation

HoloLand is the platform layer. HoloScript is the source layer. This index is the navigation hub for HoloLand-rooted docs only. Language, runtime, deployment, MCP, and architecture topics are HoloScript- canonical — most rows below either point at HoloScript or are HoloLand-specific overlays.

Repo-root entry points: README.md · QUICKSTART.md · ECOSYSTEM_STATUS.md · CONTRIBUTING.md

What changed in 2026-05-11 cleanup: Wave 1 retired 27 completion- report files to archive/. Wave 2 redirected 22 docs to HoloScript canonical. Wave 3 archived PILOT_DEPLOYMENT_COMPLETE.md. Wave 4 Batches A–E refreshed living docs against current code (Brittney, architecture, perf/cache, guides/specs, top-of-funnel + INDEX). Dead links to retired files have been removed.

Boundary docs (read first)

Doc What it says
HOLOLAND_PURPOSE.md What HoloLand owns vs HoloScript
HOLOSCRIPT_SOURCE_CONTRACT.md .holo / .hs / .hsplus is source; .ts / .tsx is migration debt
PROPERTY_RIGHTS_AND_PRIVACY.md Spatial-ownership policy + privacy posture (design intent, not shipped)
specs/HOLOSCRIPT_FIRST_MIGRATION.md Why HoloScript leads
specs/NO_TSX_MIGRATION.md The no-TSX policy

Getting started

Doc Description
GETTING_STARTED.md Install HoloScript, then HoloLand; run a HoloLand-rendered world
CREATOR_QUICKSTART.md Creator path: pointers to HoloScript-canonical authoring + HoloLand surfaces
2D_APP_GUIDE.md What 2D output paths actually exist (HoloScript-canonical compile targets)
QUICKSTART.md Repo-root 5-minute quick-start

External canonical: HoloScript/docs/guides/installation.md · HoloScript/docs/guides/quick-start.md · HoloScript/docs/guides/first-ai-scene.md · HoloScript/docs/guides/first-ai-npc.md

Brittney AI (HoloLand-side runtime)

Doc Description
BRITTNEY_CONTEXT.md Canonical: Brittney sub-packages, roles, runtime
BRITTNEY_OWNERSHIP_MODEL.md Cross-repo split (HoloScript / Studio / HoloLand)
BRITTNEY_MODELS_DEPLOYMENT.md Inference deployment (toolkit GGUF + @hololand/inference)
BRITTNEY_ACCESS_CONTRACT.md Required access matrix and receipt declaration for Brittney descendants
BRITTNEY_AI_PACKAGE_INDEX.md → redirect to HoloScript canonical (verify before use)
BRITTNEY_HOLOSCRIPT_CONTEXT.md → redirect to HoloScript canonical

The HoloScript-canonical Brittney CLI agent lives at HoloScript/packages/aibrittney/.

Platform & runtime (HoloLand-specific)

Refreshed in Wave 4 Batches A–D against current source:

Doc Description
AVATAR_STUDIO_BRIDGE.md HoloScript ↔ AvatarBlueprint ↔ VRM 1.0 export; Ready Player Me migration
DISTRIBUTED_SCENE_GRAPH.md Multiplayer scene-graph state
HOLOGRAPHIC_UI.md UI primitives composable from .holo
GEOSPATIAL_ANCHORING.md Geo-anchored content
RUNTIME_SERVICE_CATALOG.md Live runtime services
QUALITY_TIER_PROFILES.md Quality / budget tiers
PERFORMANCE_TUNING.md Performance practices
AUTONOMOUS_VR_OPTIMIZATION_ROADMAP.md Autonomous optimization roadmap
CACHING.md Procedural + streaming caches
IOT_DIGITAL_TWINS_SHOWCASE.md IoT → .holo digital twins
EXAMPLES_GALLERY.md Category map of examples/ subdirectories
DEVELOPER_PORTAL.md Developer entry index
VR_STUDIO_DESIGN.md In-VR studio design (not yet shipped — explicitly marked)

API / contracts

Doc Description
API_REFERENCE.md Module-pointer table (no hardcoded counts; verify with ls)
api.openapi.yaml OpenAPI HTTP surface
UAA2_API_CONTRACT.md Agent contract
AGENT_HOLOSCRIPT_TOOLING.md HoloScript MCP tools for HoloLand agents

External canonical: HoloScript/docs/api/ · HoloScript/docs/api/MCP_EXAMPLES.md · HoloScript/docs/api/REST_EXAMPLES.md · HoloScript/docs/api/CLI.md · HoloScript/docs/api/traits.md

Hardware & validation

Doc Description
HARDWARE_VALIDATION.md On-device receipts (Quest, Vision Pro, AR phones, desktop XR)
SECURITY_BEST_PRACTICES.md HoloLand-specific spatial / avatar / social / .holo content moderation
guides/device-lab-probe.md Device-lab probe procedure

External canonical: HoloScript/docs/security/SECURITY.md · HoloScript/docs/security/SECURITY_HARDENING_GUIDE.md

Deployment

Most deployment docs in this tree are Wave 2 redirects to HoloScript canonical:

Doc Status
DEPLOYMENT_BROWSER.md → redirect to HoloScript WebXR canonical
DEPLOYMENT_CHECKLIST.md → redirect to HoloScript deployment canonical
DEPLOYMENT_CLOUD_SYNC.md → redirect to HoloScript canonical
DEPLOYMENT_MOBILE.md Original full guide (not yet redirected; verify against current React Native packages before relying on it)
DEPLOYMENT_TAURI.md Original full guide (not yet redirected; verify against current Tauri setup before relying on it)
USER_DEPLOYMENT_GUIDE.md → redirect to HoloScript canonical

External canonical: HoloScript/docs/deployment/DEPLOYMENT.md · HoloScript/docs/platforms/WEBXR.md

Language / file types (all redirects)

These are Wave 2 redirects — HoloScript is canonical for all language and file-type material.

Doc Status
HOLOSCRIPT_LANGUAGE_SPEC.md → redirect
HOLOSCRIPT_LANGUAGE_REFERENCE.md → redirect
HOLOSCRIPT_LANGUAGE_COMPARISON.md → redirect
HSPLUS_LANGUAGE_SPEC.md → redirect
HOLOSCRIPT_FILE_TYPES.md → redirect
HOLOSCRIPT_INTEGRATION_GUIDE.md → redirect
HOLOSCRIPT_SECTOR_EXAMPLES.md → redirect
MCP_BEST_PRACTICES.md → redirect

Architecture (mostly redirects)

Doc Status
ARCHITECTURE_DECISIONS.md → redirect to HoloScript canonical
HOLOLAND_CENTRAL_ARCHITECTURE.md → redirect to HoloScript canonical
HOLO_ECOSYSTEM_DEVELOPER_GUIDE.md → redirect to HoloScript canonical
PLATFORM_VISION.md → redirect to HoloScript canonical
BACKEND_NODES_DESIGN.md HoloLand-specific backend design

Specs (HoloLand-specific)

Spec Description
specs/HOLOLAND_FRONTIER_NORTH_STAR.md Programmable living frontier — strategic target
specs/HOLOLAND_RUNTIME_ATLAS.md Runtime atlas for layers, places, domains, verticals, and receipts
specs/HOLOSCRIPT_FIRST_MIGRATION.md HoloScript-first migration policy
specs/NO_TSX_MIGRATION.md Zero-.tsx end-state policy
specs/HOLOLAND_CENTRAL_ACCESSIBILITY_GAMEPLAN.md Accessibility plan
specs/SOCIAL_FEATURES_SPEC.md Social features spec
specs/TIERED_CHAT_GAMEPLAN.md Tiered chat plan
specs/NOCODE_WORLD_BUILDER_SPEC.md No-code builder spec
specs/CREATOR_PROGRAM_SYSTEM.md Creator program spec
specs/CREATOR_ONBOARDING_PLATFORM.md Creator onboarding spec
specs/AI_AGENT_INTEGRATION_SYSTEM.md Agent integration spec
specs/frontier-encounter-manifest.holo Frontier encounter manifest (.holo source)
specs/frontier-encounter-manifest.schema.json Frontier encounter manifest schema
specs/HOLOLAND_3_LAYERS 3-layer architecture spec
specs/HOLOLAND_BUILDER_EXPERIENCE Builder experience spec
specs/HOLOLAND_GAMING Gaming spec
specs/HOLOLAND_LANDING_EXPERIENCE Landing experience spec

Audits

Doc Description
audits/HOLOLAND_CODEBASE_SHOULD_EXIST_AUDIT_2026-05-07.md Disk-grounded should-exist audit (2026-05-07) — authoritative
HOLOLAND_DOCUMENTATION_AUDIT_MARCH_2026.md Earlier audit; some "deprecated" calls were wrong (corrected via header)
DOCUMENTATION_AUDIT_2026-02-21.md Older audit

Pilots

Doc Description
pilots/README.md Pilot index
pilots/NEUROMORPHIC_WAREHOUSE_PILOT.md Neuromorphic warehouse pilot
pilots/NEUROMORPHIC_PILOT_EXECUTIVE_SUMMARY.md Executive summary
pilots/PILOT_QUICK_REFERENCE.md Quick reference

Guides

Doc Description
guides/device-lab-probe.md Device-lab probe procedure
guides/DEVELOPMENT_ENVIRONMENT_SETUP.md → redirect to HoloScript installation
guides/QUICK_REFERENCE.md → redirect to INDEX / GETTING_STARTED

Strategy & knowledge

Doc Description
strategy/HOLOLAND_LIVING_COMPETITOR_GAP_MATRIX.md Living competitor matrix
knowledge/vr-performance-wisdom.md VR performance lessons

Folder structure

docs/
├── audits/         — disk-grounded audits
├── archive/        — Wave 1/3 retired completion-report cruft
├── assets/         — images
├── guides/         — operational guides
├── knowledge/      — distilled wisdom
├── pilots/         — pilot documentation
├── specs/          — HoloLand-specific specs (gameplay, layers, builder, etc.)
├── strategy/       — strategy material
├── INDEX.md        — this file
└── *.md            — top-level HoloLand docs (mix of refreshed + redirected)

Discovering external canonical material

Live counts and per-package inventories are NOT pinned in this index (F.014: zero hardcoded stats). Verify on demand:

Question Path
Number / list of HoloScript MCP tools tools/list against mcp.holoscript.net; never hardcode
Compile targets compile_to_* MCP tool discovery, or HoloScript/docs/NUMBERS.md
HoloLand packages on disk ls packages/, then per-folder READMEs
Live examples/ subdirectories ls examples/

What was removed in 2026-05-11 cleanup

Dead links to the following retired files have been removed from this INDEX. They are preserved in archive/ (history) but should not be linked from current docs:

  • All BATTLEARENA_* files (game-specific completion reports)
  • ∞.BATTLEARENA_BRITTNEY_GAME_2026_02_03.md (unicode-prefixed BattleArena delivery file)
  • All BRITTNEY_GAME_* files (game-specific delivery reports)
  • All WEEK*, STEP* completion reports
  • DEVELOPER_PORTAL_COMPLETE.md, DOCUMENTATION_*_COMPLETE.md
  • MARKETING_MATERIALS.md, MARKETING_PLAYBOOK.md
  • HOLOLAND_OASIS_CENTRAL_DESIGN.md
  • ECOSYSTEM_AUDIT_2026-01.md
  • VR_FITNESS_MARKETPLACE.md (Batch D archive)
  • MICROSOFT_MESH_MIGRATION_GUIDE.md (Batch D archive)
  • BRITTNEY_SYSTEM_REFERENCE.md (described an API surface no longer in source)
  • BRITTNEY_FINETUNING_INSTRUCTIONS.md (referenced in old INDEX but not present on disk)

If a previously-linked doc is missing from this index, it was either archived, redirected, or never existed on disk. Use git log -- docs/<name> to trace history.