Files
proxmox/docs/00-meta/DOCUMENT_RELATIONSHIP_MAP.md
defiQUG fbda1b4beb
Some checks failed
Deploy to Phoenix / deploy (push) Has been cancelled
docs: Ledger Live integration, contract deploy learnings, NEXT_STEPS updates
- ADD_CHAIN138_TO_LEDGER_LIVE: Ledger form done; public code review repo bis-innovations/LedgerLive; init/push commands
- CONTRACT_DEPLOYMENT_RUNBOOK: Chain 138 gas price 1 gwei, 36-addr check, TransactionMirror workaround
- CONTRACT_*: AddressMapper, MirrorManager deployed 2026-02-12; 36-address on-chain check
- NEXT_STEPS_FOR_YOU: Ledger done; steps completable now (no LAN); run-completable-tasks-from-anywhere
- MASTER_INDEX, OPERATOR_OPTIONAL, SMART_CONTRACTS_INVENTORY_SIMPLE: updates
- LEDGER_BLOCKCHAIN_INTEGRATION_COMPLETE: bis-innovations/LedgerLive reference

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-02-12 15:46:57 -08:00

2.5 KiB
Raw Blame History

Document Relationship Map

Last Updated: 2026-01-31
Document Version: 1.0
Status: Active Documentation


Overview

Optional high-level map of how key documentation links together. Use for onboarding and to avoid orphaned docs.


Relationship Diagram (Mermaid)

flowchart TB
  subgraph entry["Entry points"]
    MASTER[MASTER_INDEX.md]
    DOCS_README[docs/README.md]
    SEARCH[SEARCH_GUIDE.md]
  end

  subgraph categories["Category READMEs (0212)"]
    A[02-architecture/README]
    B[03-deployment/README]
    C[04-configuration/README]
    D[05-network/README]
    E[09-troubleshooting/README]
    F[11-references/README]
    G[12-quick-reference/README]
  end

  subgraph meta["00-meta"]
    STYLE[DOCUMENTATION_STYLE_GUIDE]
    TASKS[DOCUMENTATION_FIX_TASK_LIST]
    METRICS[DOCUMENTATION_METRICS]
  end

  subgraph key["Key docs"]
    NET[NETWORK_ARCHITECTURE]
    VMID[VMID_ALLOCATION_FINAL]
    CLOUD[CLOUDFLARE_ROUTING_MASTER]
    RUN[OPERATIONAL_RUNBOOKS]
    FAQ[TROUBLESHOOTING_FAQ]
    CARDS[QUICK_REFERENCE_CARDS]
  end

  MASTER --> A & B & C & D & E & F & G
  DOCS_README --> A & B & C
  SEARCH --> MASTER
  A --> NET & VMID
  D --> CLOUD
  B --> RUN
  E --> FAQ
  G --> CARDS
  STYLE --> TASKS & METRICS

ASCII Summary

MASTER_INDEX.md ──┬── 02-architecture/README ── NETWORK_ARCHITECTURE, VMID_ALLOCATION_FINAL
                  ├── 03-deployment/README   ── OPERATIONAL_RUNBOOKS
                  ├── 04-configuration/README
                  ├── 05-network/README      ── CLOUDFLARE_ROUTING_MASTER
                  ├── 09-troubleshooting/README ── TROUBLESHOOTING_FAQ
                  ├── 11-references/README   ── NETWORK_CONFIGURATION_MASTER, GLOSSARY
                  └── 12-quick-reference/README ── QUICK_REFERENCE_CARDS

00-meta/ ── DOCUMENTATION_STYLE_GUIDE ── DOCUMENTATION_FIX_TASK_LIST, DOCUMENTATION_METRICS

Optional: State Diagram Example (Container Lifecycle)

stateDiagram-v2
  [*] --> created
  created --> running: start
  running --> stopped: stop
  stopped --> running: start
  running --> [*]: destroy
  stopped --> [*]: destroy

ASCII equivalent: [created] --start--> [running] --stop--> [stopped] --start--> [running].