Skip to content

Commit 64d6a04

Browse files
docs(Maintain): improve table formatting in DeepDive documentation
Enhance markdown table readability in Documentation/GitHub/DeepDive.md by adjusting column width specifications and text wrapping. The table column definitions now use explicit widths (e.g., :---, :-----------------------------------------) instead of generic placeholders, providing better visual alignment in markdown renderers. Also normalize the rustdocflags array in .cargo/config.toml to single-line format for consistency.
1 parent 6a0f6ba commit 64d6a04

3 files changed

Lines changed: 45 additions & 48 deletions

File tree

.cargo/config.toml

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
[build]
22
target-dir = "Target"
3-
rustdocflags = [
4-
"-Zunstable-options",
5-
"--enable-index-page",
6-
]
3+
rustdocflags = ["-Zunstable-options", "--enable-index-page"]
74

85
[net]
96
git-fetch-with-cli = true

.github/Update.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
Update: Mon Apr 6 01:29:09 UTC 2026
1+
Update: Mon Apr 6 01:29:09 UTC 2026

Documentation/GitHub/DeepDive.md

Lines changed: 43 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
This document provides the technical foundation for the Maintain build system
44
and CI/CD toolkit within the Land ecosystem. **Maintain** orchestrates builds
5-
across all Land elements, embeds a Rhai scripting engine for flexible automation,
6-
and provides type-safe TOML/JSON5 configuration editing.
5+
across all Land elements, embeds a Rhai scripting engine for flexible
6+
automation, and provides type-safe TOML/JSON5 configuration editing.
77

88
---
99

@@ -67,23 +67,23 @@ graph TB
6767

6868
## Key Modules
6969

70-
| Path | Description |
71-
| :--- | :--- |
72-
| `Source/Library.rs` | Binary entry point; wires together CLI, logging, and error handling |
73-
| `Source/Build/CLI.rs` | `clap`-based CLI with subcommands: debug, release, profile, dev |
74-
| `Source/Build/Definition.rs` | Build group definitions: which elements to build, in what order |
75-
| `Source/Build/Fn.rs` | Core build function dispatch: clean, compile, link, post-process |
76-
| `Source/Build/Process.rs` | Child process spawning with stdout/stderr capture and exit code handling |
77-
| `Source/Build/TomlEdit.rs` | Non-lossy TOML editing for `Cargo.toml` version bumps and dependency changes |
78-
| `Source/Build/JsonEdit.rs` | JSON5-aware configuration editing for `package.json` and `.json5` files |
79-
| `Source/Build/Pascalize.rs` | PascalCase ↔ words conversion utilities for naming convention enforcement |
80-
| `Source/Build/GetTauriTargetTriple.rs` | Detects current Rust target triple for SideCar binary selection |
81-
| `Source/Build/EnvironmentResolver.rs` | Resolves environment variables with fallbacks for build-time configuration |
82-
| `Source/Build/Logger.rs` | Colored terminal output using the `colored` crate |
83-
| `Source/Build/Error.rs` | Unified error type for build failures |
84-
| `Source/Build/Rhai/ConfigLoader.rs` | Loads and parses Rhai build configuration scripts |
85-
| `Source/Build/Rhai/ScriptRunner.rs` | Executes Rhai scripts within the build context with Land API bindings |
86-
| `Source/Build/Rhai/EnvironmentResolver.rs` | Exposes environment variable resolution to Rhai scripts |
70+
| Path | Description |
71+
| :----------------------------------------- | :--------------------------------------------------------------------------- |
72+
| `Source/Library.rs` | Binary entry point; wires together CLI, logging, and error handling |
73+
| `Source/Build/CLI.rs` | `clap`-based CLI with subcommands: debug, release, profile, dev |
74+
| `Source/Build/Definition.rs` | Build group definitions: which elements to build, in what order |
75+
| `Source/Build/Fn.rs` | Core build function dispatch: clean, compile, link, post-process |
76+
| `Source/Build/Process.rs` | Child process spawning with stdout/stderr capture and exit code handling |
77+
| `Source/Build/TomlEdit.rs` | Non-lossy TOML editing for `Cargo.toml` version bumps and dependency changes |
78+
| `Source/Build/JsonEdit.rs` | JSON5-aware configuration editing for `package.json` and `.json5` files |
79+
| `Source/Build/Pascalize.rs` | PascalCase ↔ words conversion utilities for naming convention enforcement |
80+
| `Source/Build/GetTauriTargetTriple.rs` | Detects current Rust target triple for SideCar binary selection |
81+
| `Source/Build/EnvironmentResolver.rs` | Resolves environment variables with fallbacks for build-time configuration |
82+
| `Source/Build/Logger.rs` | Colored terminal output using the `colored` crate |
83+
| `Source/Build/Error.rs` | Unified error type for build failures |
84+
| `Source/Build/Rhai/ConfigLoader.rs` | Loads and parses Rhai build configuration scripts |
85+
| `Source/Build/Rhai/ScriptRunner.rs` | Executes Rhai scripts within the build context with Land API bindings |
86+
| `Source/Build/Rhai/EnvironmentResolver.rs` | Exposes environment variable resolution to Rhai scripts |
8787

8888
---
8989

@@ -116,35 +116,35 @@ sequenceDiagram
116116

117117
## Integration Points
118118

119-
| Connecting Element | Direction | Mechanism | Description |
120-
| :--- | :--- | :--- | :--- |
121-
| **Mountain** | Build target | `cargo build` subprocess | Maintain compiles Mountain as part of the debug/release build group |
122-
| **Air** | Build target | `cargo build` subprocess | Air daemon compiled alongside Mountain |
123-
| **Echo** | Build target | `cargo build` subprocess | Echo scheduler compiled as a dependency of Mountain |
124-
| **Rest** | Build target | `cargo build` subprocess | Rest compiler binary built for use by Output |
125-
| **SideCar** | Build target | `cargo build` subprocess | SideCar Download tool compiled and run as part of setup |
126-
| **Output** | Build trigger | `pnpm run prepublishOnly` subprocess | Maintain triggers TypeScript builds via pnpm |
127-
| **Wind / Sky** | Build trigger | `pnpm run prepublishOnly` subprocess | Frontend packages built through Turborepo via Maintain |
119+
| Connecting Element | Direction | Mechanism | Description |
120+
| :----------------- | :------------ | :----------------------------------- | :------------------------------------------------------------------ |
121+
| **Mountain** | Build target | `cargo build` subprocess | Maintain compiles Mountain as part of the debug/release build group |
122+
| **Air** | Build target | `cargo build` subprocess | Air daemon compiled alongside Mountain |
123+
| **Echo** | Build target | `cargo build` subprocess | Echo scheduler compiled as a dependency of Mountain |
124+
| **Rest** | Build target | `cargo build` subprocess | Rest compiler binary built for use by Output |
125+
| **SideCar** | Build target | `cargo build` subprocess | SideCar Download tool compiled and run as part of setup |
126+
| **Output** | Build trigger | `pnpm run prepublishOnly` subprocess | Maintain triggers TypeScript builds via pnpm |
127+
| **Wind / Sky** | Build trigger | `pnpm run prepublishOnly` subprocess | Frontend packages built through Turborepo via Maintain |
128128

129129
---
130130

131131
## Configuration
132132

133-
| Option | CLI Flag | Description |
134-
| :--- | :--- | :--- |
135-
| Build mode | `debug` / `release` subcommand | Controls `--release` flag and optimization level |
136-
| Target triple | `--target` | Rust target triple for cross-compilation |
137-
| Element filter | `--element` | Build only a specific element rather than the full group |
138-
| Script path | `--script` | Override the default Rhai build configuration script |
139-
| Verbosity | `--verbose` | Enable detailed subprocess output logging |
133+
| Option | CLI Flag | Description |
134+
| :------------- | :----------------------------- | :------------------------------------------------------- |
135+
| Build mode | `debug` / `release` subcommand | Controls `--release` flag and optimization level |
136+
| Target triple | `--target` | Rust target triple for cross-compilation |
137+
| Element filter | `--element` | Build only a specific element rather than the full group |
138+
| Script path | `--script` | Override the default Rhai build configuration script |
139+
| Verbosity | `--verbose` | Enable detailed subprocess output logging |
140140

141141
**Shell script entry points:**
142142

143-
| Script | Purpose |
144-
| :--- | :--- |
145-
| `Debug.sh` | Full debug build of all elements |
146-
| `Dev-Mountain.sh` | Hot-reload development mode for Mountain |
147-
| `Release.sh` | Optimized release build with all elements |
148-
| `Profile.sh` | Release build with profiling instrumentation |
149-
| `Debug/All.sh` | Debug all components including frontend |
150-
| `Debug/Wind.sh` | Debug Wind TypeScript service layer only |
143+
| Script | Purpose |
144+
| :---------------- | :------------------------------------------- |
145+
| `Debug.sh` | Full debug build of all elements |
146+
| `Dev-Mountain.sh` | Hot-reload development mode for Mountain |
147+
| `Release.sh` | Optimized release build with all elements |
148+
| `Profile.sh` | Release build with profiling instrumentation |
149+
| `Debug/All.sh` | Debug all components including frontend |
150+
| `Debug/Wind.sh` | Debug Wind TypeScript service layer only |

0 commit comments

Comments
 (0)