Skip to content

docs(arcane-core): add one-line module-level doc comment to lib.rs #105

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
martinjms wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(arcane-core): add one-line module-level doc comment to lib.rs #105

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 1 addition & 15 deletions crates/arcane-core/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,4 @@
//! Arcane Engine — core traits and shared types.
//!
//! Defines the stable, I/O-free contracts used by the rest of the workspace.
//!
//! ## Module responsibilities
//! - `types`: shared math and geometry primitives (`Vec2`, `Vec3`, `ClusterGeometry`).
//! - `clustering_model`: merge/split decision interface consumed by manager logic.
//! - `server_pool`: allocation/release contract for cluster server capacity.
//! - `replication_channel`: neighbor-delta contract, [`EntityStateEntry`](replication_channel::EntityStateEntry) (four-bucket spine + JSON fields), [`IReplicationChannel`](replication_channel::IReplicationChannel).
//! - `world_simulator`: contract for unobserved entity state progression.
//!
//! ## Interaction model
//! Implementations in sibling crates (`arcane-rules`, `arcane-pool`, `arcane-infra`) depend on
//! these contracts. `arcane-core` itself has no runtime side effects and should remain a dependency
//! root for cross-crate compatibility.
//! Core types and traits for the Arcane real-time multiplayer engine.

pub mod cluster_simulation;
pub mod clustering_model;
Expand Down
Loading