490 lines
21 KiB
HTML
490 lines
21 KiB
HTML
|
<!DOCTYPE HTML>
|
||
|
|
<html lang="en" class="light sidebar-visible" dir="ltr">
|
||
|
|
<head>
|
||
|
|
<!-- Book generated using mdBook -->
|
||
|
|
<meta charset="UTF-8">
|
||
|
|
<title>0027: Documentation Layers - VAPORA Platform Documentation</title>
|
||
|
|
|
||
|
|
|
||
|
|
<!-- Custom HTML head -->
|
||
|
|
|
||
|
|
<meta name="description" content="Comprehensive documentation for VAPORA, an intelligent development orchestration platform built entirely in Rust.">
|
||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||
|
|
<meta name="theme-color" content="#ffffff">
|
||
|
|
|
||
|
|
<link rel="icon" href="../favicon.svg">
|
||
|
|
<link rel="shortcut icon" href="../favicon.png">
|
||
|
|
<link rel="stylesheet" href="../css/variables.css">
|
||
|
|
<link rel="stylesheet" href="../css/general.css">
|
||
|
|
<link rel="stylesheet" href="../css/chrome.css">
|
||
|
|
<link rel="stylesheet" href="../css/print.css" media="print">
|
||
|
|
|
||
|
|
<!-- Fonts -->
|
||
|
|
<link rel="stylesheet" href="../FontAwesome/css/font-awesome.css">
|
||
|
|
<link rel="stylesheet" href="../fonts/fonts.css">
|
||
|
|
|
||
|
|
<!-- Highlight.js Stylesheets -->
|
||
|
|
<link rel="stylesheet" id="highlight-css" href="../highlight.css">
|
||
|
|
<link rel="stylesheet" id="tomorrow-night-css" href="../tomorrow-night.css">
|
||
|
|
<link rel="stylesheet" id="ayu-highlight-css" href="../ayu-highlight.css">
|
||
|
|
|
||
|
|
<!-- Custom theme stylesheets -->
|
||
|
|
|
||
|
|
|
||
|
|
<!-- Provide site root and default themes to javascript -->
|
||
|
|
<script>
|
||
|
|
const path_to_root = "../";
|
||
|
|
const default_light_theme = "light";
|
||
|
|
const default_dark_theme = "dark";
|
||
|
|
</script>
|
||
|
|
<!-- Start loading toc.js asap -->
|
||
|
|
<script src="../toc.js"></script>
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<div id="mdbook-help-container">
|
||
|
|
<div id="mdbook-help-popup">
|
||
|
|
<h2 class="mdbook-help-title">Keyboard shortcuts</h2>
|
||
|
|
<div>
|
||
|
|
<p>Press <kbd>←</kbd> or <kbd>→</kbd> to navigate between chapters</p>
|
||
|
|
<p>Press <kbd>S</kbd> or <kbd>/</kbd> to search in the book</p>
|
||
|
|
<p>Press <kbd>?</kbd> to show this help</p>
|
||
|
|
<p>Press <kbd>Esc</kbd> to hide this help</p>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div id="body-container">
|
||
|
|
<!-- Work around some values being stored in localStorage wrapped in quotes -->
|
||
|
|
<script>
|
||
|
|
try {
|
||
|
|
let theme = localStorage.getItem('mdbook-theme');
|
||
|
|
let sidebar = localStorage.getItem('mdbook-sidebar');
|
||
|
|
|
||
|
|
if (theme.startsWith('"') && theme.endsWith('"')) {
|
||
|
|
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
|
||
|
|
}
|
||
|
|
|
||
|
|
if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
|
||
|
|
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
|
||
|
|
}
|
||
|
|
} catch (e) { }
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<!-- Set the theme before any content is loaded, prevents flash -->
|
||
|
|
<script>
|
||
|
|
const default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? default_dark_theme : default_light_theme;
|
||
|
|
let theme;
|
||
|
|
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
|
||
|
|
if (theme === null || theme === undefined) { theme = default_theme; }
|
||
|
|
const html = document.documentElement;
|
||
|
|
html.classList.remove('light')
|
||
|
|
html.classList.add(theme);
|
||
|
|
html.classList.add("js");
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<input type="checkbox" id="sidebar-toggle-anchor" class="hidden">
|
||
|
|
|
||
|
|
<!-- Hide / unhide sidebar before it is displayed -->
|
||
|
|
<script>
|
||
|
|
let sidebar = null;
|
||
|
|
const sidebar_toggle = document.getElementById("sidebar-toggle-anchor");
|
||
|
|
if (document.body.clientWidth >= 1080) {
|
||
|
|
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
|
||
|
|
sidebar = sidebar || 'visible';
|
||
|
|
} else {
|
||
|
|
sidebar = 'hidden';
|
||
|
|
}
|
||
|
|
sidebar_toggle.checked = sidebar === 'visible';
|
||
|
|
html.classList.remove('sidebar-visible');
|
||
|
|
html.classList.add("sidebar-" + sidebar);
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<nav id="sidebar" class="sidebar" aria-label="Table of contents">
|
||
|
|
<!-- populated by js -->
|
||
|
|
<mdbook-sidebar-scrollbox class="sidebar-scrollbox"></mdbook-sidebar-scrollbox>
|
||
|
|
<noscript>
|
||
|
|
<iframe class="sidebar-iframe-outer" src="../toc.html"></iframe>
|
||
|
|
</noscript>
|
||
|
|
<div id="sidebar-resize-handle" class="sidebar-resize-handle">
|
||
|
|
<div class="sidebar-resize-indicator"></div>
|
||
|
|
</div>
|
||
|
|
</nav>
|
||
|
|
|
||
|
|
<div id="page-wrapper" class="page-wrapper">
|
||
|
|
|
||
|
|
<div class="page">
|
||
|
|
<div id="menu-bar-hover-placeholder"></div>
|
||
|
|
<div id="menu-bar" class="menu-bar sticky">
|
||
|
|
<div class="left-buttons">
|
||
|
|
<label id="sidebar-toggle" class="icon-button" for="sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
|
||
|
|
<i class="fa fa-bars"></i>
|
||
|
|
</label>
|
||
|
|
<button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
|
||
|
|
<i class="fa fa-paint-brush"></i>
|
||
|
|
</button>
|
||
|
|
<ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
|
||
|
|
<li role="none"><button role="menuitem" class="theme" id="default_theme">Auto</button></li>
|
||
|
|
<li role="none"><button role="menuitem" class="theme" id="light">Light</button></li>
|
||
|
|
<li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
|
||
|
|
<li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
|
||
|
|
<li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
|
||
|
|
<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
|
||
|
|
</ul>
|
||
|
|
<button id="search-toggle" class="icon-button" type="button" title="Search (`/`)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="/ s" aria-controls="searchbar">
|
||
|
|
<i class="fa fa-search"></i>
|
||
|
|
</button>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<h1 class="menu-title">VAPORA Platform Documentation</h1>
|
||
|
|
|
||
|
|
<div class="right-buttons">
|
||
|
|
<a href="../print.html" title="Print this book" aria-label="Print this book">
|
||
|
|
<i id="print-button" class="fa fa-print"></i>
|
||
|
|
</a>
|
||
|
|
<a href="https://github.com/vapora-platform/vapora" title="Git repository" aria-label="Git repository">
|
||
|
|
<i id="git-repository-button" class="fa fa-github"></i>
|
||
|
|
</a>
|
||
|
|
<a href="https://github.com/vapora-platform/vapora/edit/main/docs/src/../adrs/0027-documentation-layers.md" title="Suggest an edit" aria-label="Suggest an edit">
|
||
|
|
<i id="git-edit-button" class="fa fa-edit"></i>
|
||
|
|
</a>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div id="search-wrapper" class="hidden">
|
||
|
|
<form id="searchbar-outer" class="searchbar-outer">
|
||
|
|
<input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
|
||
|
|
</form>
|
||
|
|
<div id="searchresults-outer" class="searchresults-outer hidden">
|
||
|
|
<div id="searchresults-header" class="searchresults-header"></div>
|
||
|
|
<ul id="searchresults">
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
|
||
|
|
<script>
|
||
|
|
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
|
||
|
|
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
|
||
|
|
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
|
||
|
|
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
|
||
|
|
});
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<div id="content" class="content">
|
||
|
|
<main>
|
||
|
|
<h1 id="adr-027-three-layer-documentation-system"><a class="header" href="#adr-027-three-layer-documentation-system">ADR-027: Three-Layer Documentation System</a></h1>
|
||
|
|
<p><strong>Status</strong>: Accepted | Implemented
|
||
|
|
<strong>Date</strong>: 2024-11-01
|
||
|
|
<strong>Deciders</strong>: Documentation & Architecture Team
|
||
|
|
<strong>Technical Story</strong>: Separating session work from permanent documentation to avoid confusion</p>
|
||
|
|
<hr />
|
||
|
|
<h2 id="decision"><a class="header" href="#decision">Decision</a></h2>
|
||
|
|
<p>Implementar <strong>three-layer documentation system</strong>: <code>.coder/</code> (session), <code>.claude/</code> (operational), <code>docs/</code> (product).</p>
|
||
|
|
<hr />
|
||
|
|
<h2 id="rationale"><a class="header" href="#rationale">Rationale</a></h2>
|
||
|
|
<ol>
|
||
|
|
<li><strong>Session Work ≠ Permanent Docs</strong>: Claude Code sessions are temporary, not product docs</li>
|
||
|
|
<li><strong>Clear Boundaries</strong>: Different audiences (devs, users, operations)</li>
|
||
|
|
<li><strong>Git Structure</strong>: Natural organization via directories</li>
|
||
|
|
<li><strong>Maintainability</strong>: Easy to distinguish what's authoritative</li>
|
||
|
|
</ol>
|
||
|
|
<hr />
|
||
|
|
<h2 id="alternatives-considered"><a class="header" href="#alternatives-considered">Alternatives Considered</a></h2>
|
||
|
|
<h3 id="-single-documentation-folder"><a class="header" href="#-single-documentation-folder">❌ Single Documentation Folder</a></h3>
|
||
|
|
<ul>
|
||
|
|
<li><strong>Pros</strong>: Simple</li>
|
||
|
|
<li><strong>Cons</strong>: Session files mixed with product docs, confusion</li>
|
||
|
|
</ul>
|
||
|
|
<h3 id="-documentation-only-no-session-tracking"><a class="header" href="#-documentation-only-no-session-tracking">❌ Documentation Only (No Session Tracking)</a></h3>
|
||
|
|
<ul>
|
||
|
|
<li><strong>Pros</strong>: Clean product docs</li>
|
||
|
|
<li><strong>Cons</strong>: No record of how decisions were made</li>
|
||
|
|
</ul>
|
||
|
|
<h3 id="-three-layers-chosen"><a class="header" href="#-three-layers-chosen">✅ Three Layers (CHOSEN)</a></h3>
|
||
|
|
<ul>
|
||
|
|
<li>Separates concerns, clear boundaries</li>
|
||
|
|
</ul>
|
||
|
|
<hr />
|
||
|
|
<h2 id="trade-offs"><a class="header" href="#trade-offs">Trade-offs</a></h2>
|
||
|
|
<p><strong>Pros</strong>:</p>
|
||
|
|
<ul>
|
||
|
|
<li>✅ Clear separation of concerns</li>
|
||
|
|
<li>✅ Session files don't pollute product docs</li>
|
||
|
|
<li>✅ Different retention/publication policies</li>
|
||
|
|
<li>✅ Audit trail of decisions</li>
|
||
|
|
</ul>
|
||
|
|
<p><strong>Cons</strong>:</p>
|
||
|
|
<ul>
|
||
|
|
<li>⚠️ More directories to manage</li>
|
||
|
|
<li>⚠️ Naming conventions required</li>
|
||
|
|
<li>⚠️ NO cross-layer links allowed (complexity)</li>
|
||
|
|
</ul>
|
||
|
|
<hr />
|
||
|
|
<h2 id="implementation"><a class="header" href="#implementation">Implementation</a></h2>
|
||
|
|
<p><strong>Layer 1: Session Files (<code>.coder/</code>)</strong>:</p>
|
||
|
|
<pre><code>.coder/
|
||
|
|
├── 2026-01-10-agent-coordinator-refactor.plan.md
|
||
|
|
├── 2026-01-10-agent-coordinator-refactor.done.md
|
||
|
|
├── 2026-01-11-bug-analysis.info.md
|
||
|
|
├── 2026-01-12-pr-review.review.md
|
||
|
|
└── 2026-01-12-backup-recovery-automation.done.md
|
||
|
|
</code></pre>
|
||
|
|
<p><strong>Naming Convention</strong>: <code>YYYY-MM-DD-description.{plan|done|info|review}.md</code></p>
|
||
|
|
<p><strong>Content</strong>: Claude Code interaction records, not product documentation.</p>
|
||
|
|
<pre><code class="language-markdown"># Agent Coordinator Refactor - COMPLETED
|
||
|
|
|
||
|
|
**Date**: January 10, 2026
|
||
|
|
**Status**: ✅ COMPLETE
|
||
|
|
**Task**: Refactor agent coordinator to reduce latency
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## What Was Done
|
||
|
|
|
||
|
|
1. Analyzed current coordinator performance
|
||
|
|
2. Identified bottleneck: sequential task assignment
|
||
|
|
3. Implemented parallel task dispatch
|
||
|
|
4. Benchmarked: 50ms → 15ms latency
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## Key Decisions
|
||
|
|
|
||
|
|
- Use `tokio::spawn` for parallel dispatch
|
||
|
|
- Keep single source of truth (still in Arc<RwLock>)
|
||
|
|
|
||
|
|
## Next Steps
|
||
|
|
|
||
|
|
(User's choice)
|
||
|
|
</code></pre>
|
||
|
|
<p><strong>Layer 2: Operational Files (<code>.claude/</code>)</strong>:</p>
|
||
|
|
<pre><code>.claude/
|
||
|
|
├── CLAUDE.md # Project-specific Claude Code instructions
|
||
|
|
├── guidelines/
|
||
|
|
│ ├── rust.md
|
||
|
|
│ ├── nushell.md
|
||
|
|
│ └── nickel.md
|
||
|
|
├── layout_conventions.md
|
||
|
|
├── doc-config.toml
|
||
|
|
└── project-settings.json
|
||
|
|
</code></pre>
|
||
|
|
<p><strong>Content</strong>: Claude Code configuration, guidelines, conventions.</p>
|
||
|
|
<pre><code class="language-markdown"># CLAUDE.md - Project Guidelines
|
||
|
|
|
||
|
|
Senior Rust developer mode. See guidelines/ for language-specific rules.
|
||
|
|
|
||
|
|
## Mandatory Guidelines
|
||
|
|
|
||
|
|
@guidelines/rust.md
|
||
|
|
@guidelines/nushell.md
|
||
|
|
</code></pre>
|
||
|
|
<p><strong>Layer 3: Product Documentation (<code>docs/</code>)</strong>:</p>
|
||
|
|
<pre><code>docs/
|
||
|
|
├── README.md # Main documentation index
|
||
|
|
├── architecture/
|
||
|
|
│ ├── README.md
|
||
|
|
│ ├── overview.md
|
||
|
|
│ └── design-patterns.md
|
||
|
|
├── adrs/
|
||
|
|
│ ├── README.md # ADRs index
|
||
|
|
│ ├── 0001-cargo-workspace.md
|
||
|
|
│ └── ... (all 27 ADRs)
|
||
|
|
├── operations/
|
||
|
|
│ ├── README.md
|
||
|
|
│ ├── deployment.md
|
||
|
|
│ └── monitoring.md
|
||
|
|
├── api/
|
||
|
|
│ ├── README.md
|
||
|
|
│ └── endpoints.md
|
||
|
|
└── guides/
|
||
|
|
├── README.md
|
||
|
|
└── getting-started.md
|
||
|
|
</code></pre>
|
||
|
|
<p><strong>Content</strong>: User-facing, permanent, mdBook-compatible documentation.</p>
|
||
|
|
<pre><code class="language-markdown"># VAPORA Architecture Overview
|
||
|
|
|
||
|
|
This is permanent product documentation.
|
||
|
|
|
||
|
|
## Core Components
|
||
|
|
|
||
|
|
- Backend: Axum REST API
|
||
|
|
- Frontend: Leptos WASM
|
||
|
|
- Database: SurrealDB
|
||
|
|
</code></pre>
|
||
|
|
<p><strong>Linking Rules</strong>:</p>
|
||
|
|
<pre><code>✅ ALLOWED:
|
||
|
|
- docs/ → docs/ (internal links)
|
||
|
|
- docs/ → external sites
|
||
|
|
- .claude/ → .claude/
|
||
|
|
- .coder/ → .coder/
|
||
|
|
|
||
|
|
❌ FORBIDDEN:
|
||
|
|
- docs/ → .coder/ (product docs can't reference session files)
|
||
|
|
- docs/ → .claude/ (product docs shouldn't reference operational files)
|
||
|
|
- .coder/ → docs/ (session files can reference product docs though)
|
||
|
|
</code></pre>
|
||
|
|
<p><strong>Files and Locations</strong>:</p>
|
||
|
|
<pre><pre class="playground"><code class="language-rust"><span class="boring">#![allow(unused)]
|
||
|
|
</span><span class="boring">fn main() {
|
||
|
|
</span>// crates/vapora-backend/src/lib.rs
|
||
|
|
//! Product documentation in docs/
|
||
|
|
//! Operational guidelines in .claude/guidelines/
|
||
|
|
//! Session work in .coder/
|
||
|
|
|
||
|
|
// Example in code:
|
||
|
|
// See: docs/adrs/0002-axum-backend.md (✅ OK: product doc)
|
||
|
|
// See: .claude/guidelines/rust.md (✅ OK: within operational layer)
|
||
|
|
// See: .coder/2026-01-10-notes.md (❌ WRONG: session file in product context)
|
||
|
|
<span class="boring">}</span></code></pre></pre>
|
||
|
|
<p><strong>Documentation Naming</strong>:</p>
|
||
|
|
<pre><code>docs/
|
||
|
|
├── README.md ← UPPERCASE (GitHub convention)
|
||
|
|
├── guides/
|
||
|
|
│ ├── README.md
|
||
|
|
│ ├── installation.md ← lowercase kebab-case
|
||
|
|
│ ├── deployment-guide.md ← lowercase kebab-case
|
||
|
|
│ └── multi-agent-workflows.md
|
||
|
|
|
||
|
|
.coder/
|
||
|
|
├── 2026-01-12-description.done.md ← YYYY-MM-DD-kebab-case.extension
|
||
|
|
|
||
|
|
.claude/
|
||
|
|
├── CLAUDE.md ← Mixed case (project instructions)
|
||
|
|
├── guidelines/
|
||
|
|
│ ├── rust.md ← lowercase (language-specific)
|
||
|
|
│ └── nushell.md
|
||
|
|
</code></pre>
|
||
|
|
<p><strong>mdBook Configuration</strong>:</p>
|
||
|
|
<pre><code class="language-toml"># mdbook.toml
|
||
|
|
[book]
|
||
|
|
title = "VAPORA Documentation"
|
||
|
|
authors = ["VAPORA Team"]
|
||
|
|
language = "en"
|
||
|
|
src = "docs"
|
||
|
|
|
||
|
|
[build]
|
||
|
|
create-missing = true
|
||
|
|
|
||
|
|
[output.html]
|
||
|
|
default-theme = "light"
|
||
|
|
</code></pre>
|
||
|
|
<p><strong>Key Files</strong>:</p>
|
||
|
|
<ul>
|
||
|
|
<li><code>.claude/CLAUDE.md</code> (project instructions)</li>
|
||
|
|
<li><code>.claude/guidelines/</code> (language guidelines)</li>
|
||
|
|
<li><code>docs/README.md</code> (documentation index)</li>
|
||
|
|
<li><code>docs/adrs/README.md</code> (ADRs index)</li>
|
||
|
|
<li><code>.coder/</code> (session files)</li>
|
||
|
|
</ul>
|
||
|
|
<hr />
|
||
|
|
<h2 id="verification"><a class="header" href="#verification">Verification</a></h2>
|
||
|
|
<pre><code class="language-bash"># Check for broken doc layer links
|
||
|
|
grep -r "\.coder" docs/ 2>/dev/null # Should be empty (❌ if not)
|
||
|
|
grep -r "\.claude" docs/ 2>/dev/null # Should be empty (❌ if not)
|
||
|
|
|
||
|
|
# Verify session files don't pollute docs/
|
||
|
|
ls docs/ | grep -E "^[0-9]" # Should be empty (❌ if not)
|
||
|
|
|
||
|
|
# Check documentation structure
|
||
|
|
[ -f docs/README.md ] && echo "✅ docs/README.md exists"
|
||
|
|
[ -f .claude/CLAUDE.md ] && echo "✅ .claude/CLAUDE.md exists"
|
||
|
|
[ -d .coder ] && echo "✅ .coder directory exists"
|
||
|
|
|
||
|
|
# Verify naming conventions
|
||
|
|
ls .coder/ | grep -v "^[0-9][0-9][0-9][0-9]-" # Check format
|
||
|
|
</code></pre>
|
||
|
|
<p><strong>Expected Output</strong>:</p>
|
||
|
|
<ul>
|
||
|
|
<li>No links from docs/ to .coder/ or .claude/</li>
|
||
|
|
<li>No session files in docs/</li>
|
||
|
|
<li>All documentation layers present</li>
|
||
|
|
<li>Naming conventions followed</li>
|
||
|
|
</ul>
|
||
|
|
<hr />
|
||
|
|
<h2 id="consequences"><a class="header" href="#consequences">Consequences</a></h2>
|
||
|
|
<h3 id="documentation-maintenance"><a class="header" href="#documentation-maintenance">Documentation Maintenance</a></h3>
|
||
|
|
<ul>
|
||
|
|
<li>Session files: temporary (can be archived/deleted)</li>
|
||
|
|
<li>Operational files: stable (part of Claude Code config)</li>
|
||
|
|
<li>Product docs: permanent (published via mdBook)</li>
|
||
|
|
</ul>
|
||
|
|
<h3 id="publication"><a class="header" href="#publication">Publication</a></h3>
|
||
|
|
<ul>
|
||
|
|
<li>Only <code>docs/</code> published to users</li>
|
||
|
|
<li><code>.claude/</code> and <code>.coder/</code> never published</li>
|
||
|
|
<li>mdBook builds from docs/ only</li>
|
||
|
|
</ul>
|
||
|
|
<h3 id="collaboration"><a class="header" href="#collaboration">Collaboration</a></h3>
|
||
|
|
<ul>
|
||
|
|
<li>Team knows where to find what</li>
|
||
|
|
<li>No confusion between session work and permanent docs</li>
|
||
|
|
<li>Clear ownership: product docs vs operational</li>
|
||
|
|
</ul>
|
||
|
|
<h3 id="scaling"><a class="header" href="#scaling">Scaling</a></h3>
|
||
|
|
<ul>
|
||
|
|
<li>Add new documents naturally</li>
|
||
|
|
<li>Layer separation doesn't break as project grows</li>
|
||
|
|
<li>mdBook generation automatic</li>
|
||
|
|
</ul>
|
||
|
|
<hr />
|
||
|
|
<h2 id="references"><a class="header" href="#references">References</a></h2>
|
||
|
|
<ul>
|
||
|
|
<li><code>.claude/layout_conventions.md</code> (comprehensive layout guide)</li>
|
||
|
|
<li><code>.claude/CLAUDE.md</code> (project-specific guidelines)</li>
|
||
|
|
<li><a href="https://rust-lang.github.io/mdBook/">mdBook Documentation</a></li>
|
||
|
|
</ul>
|
||
|
|
<hr />
|
||
|
|
<p><strong>Related ADRs</strong>: ADR-024 (Service Architecture), All ADRs (documentation)</p>
|
||
|
|
|
||
|
|
</main>
|
||
|
|
|
||
|
|
<nav class="nav-wrapper" aria-label="Page navigation">
|
||
|
|
<!-- Mobile navigation buttons -->
|
||
|
|
<a rel="prev" href="../../adrs/0026-shared-state.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
||
|
|
<i class="fa fa-angle-left"></i>
|
||
|
|
</a>
|
||
|
|
|
||
|
|
<a rel="next prefetch" href="../../integrations/index.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
||
|
|
<i class="fa fa-angle-right"></i>
|
||
|
|
</a>
|
||
|
|
|
||
|
|
<div style="clear: both"></div>
|
||
|
|
</nav>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<nav class="nav-wide-wrapper" aria-label="Page navigation">
|
||
|
|
<a rel="prev" href="../../adrs/0026-shared-state.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
||
|
|
<i class="fa fa-angle-left"></i>
|
||
|
|
</a>
|
||
|
|
|
||
|
|
<a rel="next prefetch" href="../../integrations/index.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
||
|
|
<i class="fa fa-angle-right"></i>
|
||
|
|
</a>
|
||
|
|
</nav>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<script>
|
||
|
|
window.playground_copyable = true;
|
||
|
|
</script>
|
||
|
|
|
||
|
|
|
||
|
|
<script src="../elasticlunr.min.js"></script>
|
||
|
|
<script src="../mark.min.js"></script>
|
||
|
|
<script src="../searcher.js"></script>
|
||
|
|
|
||
|
|
<script src="../clipboard.min.js"></script>
|
||
|
|
<script src="../highlight.js"></script>
|
||
|
|
<script src="../book.js"></script>
|
||
|
|
|
||
|
|
<!-- Custom JS scripts -->
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|