You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Remove internal type references from documentation
Update docs to match cleaned-up public API surface. Remove references
to internal types (BackendMode, TopicRole, TopicConfig, RtKernelInfo,
RtCpuInfo, LogEntry, SIMD_COPY_THRESHOLD, TensorPoolStats fields) and
internal helper functions (pin_thread_to_core, detect_isolated_cpus,
get_rt_recommended_cpus, prefault_stack). Fix import paths for
RtScheduler and RtApplyResult which moved out of the prelude.
Copy file name to clipboardExpand all lines: content/docs/advanced/rt-config.mdx
+16-57Lines changed: 16 additions & 57 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,9 +19,11 @@ RtConfig is designed for **development on any OS** with **production deployment
19
19
|**macOS**| Graceful degradation (no RT) | Development & testing |
20
20
|**Windows**| Graceful degradation (no RT) | Development & testing |
21
21
22
-
On non-Linux platforms, `RtConfig::apply()` returns `RtApplyResult::Degraded` and your code continues running normally - just without kernel-level RT guarantees. This allows you to develop and test on any OS.
22
+
On non-Linux platforms, `RtConfig::apply()` returns a degraded result and your code continues running normally - just without kernel-level RT guarantees. This allows you to develop and test on any OS.
@@ -172,7 +163,7 @@ mDNS allows nodes to discover each other without hardcoding IP addresses. This i
172
163
173
164
## Endpoint Configuration (Planned)
174
165
175
-
> **Note:** The endpoint configuration system (`HorusConfig`, `EndpointConfig`, transport types) is **planned but not yet implemented**. See [Communication Configuration](/concepts/communication-configuration) for the intended design. Currently, all topics use local shared memory via `Topic::new("name")` or `Topic::from_config(TopicConfig)`.
166
+
> **Note:** The endpoint configuration system (`HorusConfig`, `EndpointConfig`, transport types) is **planned but not yet implemented**. See [Communication Configuration](/concepts/communication-configuration) for the intended design. Currently, all topics use local shared memory via `Topic::new("name")`.
176
167
177
168
## Summary
178
169
@@ -183,7 +174,7 @@ mDNS allows nodes to discover each other without hardcoding IP addresses. This i
> **Note**: SIMD acceleration applies to messages >= 4KB (`SIMD_COPY_THRESHOLD`). Smaller messages use standard `ptr::copy_nonoverlapping`. The latency improvements above are from the overall Topic pipeline, including cache-line alignment and lock-free algorithms.
197
+
> **Note**: SIMD acceleration applies to messages >= 4KB. Smaller messages use standard `ptr::copy_nonoverlapping`. The latency improvements above are from the overall Topic pipeline, including cache-line alignment and lock-free algorithms.
198
198
199
199
### Fallback Behavior
200
200
@@ -561,7 +561,7 @@ HORUS automatically tracks IPC timing for each topic operation. The `horus monit
561
561
Tick: 12μs | IPC: 296ns
562
562
```
563
563
564
-
Each `LogEntry` includes `tick_us` (node tick time in microseconds) and `ipc_ns` (IPC write time in nanoseconds).
564
+
Each log entry includes `tick_us` (node tick time in microseconds) and `ipc_ns` (IPC write time in nanoseconds).
0 commit comments