BIM Integration & Architecture
This pillar focuses on creating a robust documentation architecture connected to a 3D building model. The repository operates like a Relational Database rather than a rigid folder structure.
The Entity-Based Solution
Section titled “The Entity-Based Solution”Nesting physical devices inside room folders (/living-room/samsung-tv.md) creates maintenance debt. If a device is moved, moving the file breaks URLs.
The “Docs as Code” repository will utilize flat entity collections:
src/content/docs/rooms/src/content/docs/devices/src/content/docs/materials/
BIM-Data Integration Ecosystem
Section titled “BIM-Data Integration Ecosystem”Astro Starlight natively embeds dynamic BIM (Building Information Modeling) viewers (e.g., Speckle).
- Interactive 3D Plans: Load
.ifcmodules directly in the browser. - Context-Aware Navigation: Clicking a room triggers a routing event into
src/content/docs/rooms/living-room.md, instantly displaying associated files. - Speckle Viewer Integration: Select a physical object inside the Speckle 3D viewer to automatically fetch and display its corresponding documentation note.
The BIM-Astro Sync Workflow
Section titled “The BIM-Astro Sync Workflow”- The Source of Truth for “WHERE”: The BIM model dictates physical boundaries and coordinates. Exported to Astro as JSON (e.g.,
bim_state.json). - The Source of Truth for “WHAT”: Astro Markdown houses manuals and SOPs. Each file references its BIM entity via frontmatter (
bim_id: "dev-tv-001"). - Dynamic MDX Rendering: A room’s markdown queries the BIM JSON to autogenerate lists of devices located within its boundaries.
Asset Linkage Architecture
Section titled “Asset Linkage Architecture”The geometry (BIM) must be strictly decoupled from the documentation (Markdown).
- Primary Key: The Global Unique Identifier (GUID) acts as the absolute primary key.
- Data Minimization in BIM: Metadata in BIM is restricted to essentials (Brand, Model, Unique_ID). All other data is managed in Markdown with Obsidian.
- Multi-Language: Translation is delegated to Astro. The
bim_idserves as the universal bridge linking different languages (/en/and/es/).
[!WARNING] Critical Task: ID Audit Protocol During export cycles between IFC representations and native architecture tools, GUIDs can sometimes be regenerated. A strict protocol must ensure the ID stamped into the initial markdown file is the definitive, immutable GUID to prevent breaking links.