docs

client/core/rs/src/api/mod.rs

@@ -33,7 +33,7 @@
 //! - [auth]: Requests relating to loggins in / obtaining authentication tokens.
 //! - [read]: Read only requests which retrieve data from Monitor.
 //! - [execute]: Run actions on monitor resources, eg [execute::RunBuild].
-//! - [write]: Requests which alter data, like create / update / delete resources.
+//! - [mod@write]: Requests which alter data, like create / update / delete resources.
 //!
 //! ## Errors
 //!

client/core/rs/src/entities/mod.rs

@@ -7,24 +7,43 @@ use serror::Serror;
 use strum::{Display, EnumString};
 use typeshare::typeshare;
 
+/// Subtypes of [Alert][alert::Alert].
 pub mod alert;
+/// Subtypes of [Alerter][alerter::Alerter].
 pub mod alerter;
+/// Subtypes of [ApiKey][api_key::ApiKey].
 pub mod api_key;
+/// Subtypes of [Build][build::Build].
 pub mod build;
+/// Subtypes of [Builder][builder::Builder].
 pub mod builder;
+/// [core config][config::core] and [periphery config][config::periphery]
 pub mod config;
+/// Subtypes of [Deployment][deployment::Deployment].
 pub mod deployment;
+/// Subtypes of [LogConfig][logger::LogConfig].
 pub mod logger;
+/// Subtypes of [Permission][permission::Permission].
 pub mod permission;
+/// Subtypes of [Procedure][procedure::Procedure].
 pub mod procedure;
+/// Subtypes of [Repo][repo::Repo].
 pub mod repo;
+/// Subtypes of [Resource][resource::Resource].
 pub mod resource;
+/// Subtypes of [Server][server::Server].
 pub mod server;
+/// Subtypes of [ServerTemplate][server_template::ServerTemplate].
 pub mod server_template;
+/// Subtypes of [Tag][tag::Tag].
 pub mod tag;
+/// Subtypes of [ResourcesToml][toml::ResourcesToml].
 pub mod toml;
+/// Subtypes of [Update][update::Update].
 pub mod update;
+/// Subtypes of [User][user::User].
 pub mod user;
+/// Subtypes of [UserGroup][user_group::UserGroup].
 pub mod user_group;
 
 #[typeshare(serialized_as = "number")]

client/core/rs/src/lib.rs

@@ -2,18 +2,19 @@
 //! *A system to build and deploy software accross many servers*
 //!
 //! This is a client library for the monitor core API.
-//! It contains the definitions for all application [entities]
-//! (eg. [Build][entities::build::Build], [Deployment][entities::deployment::Deployment], [Server][entities::server::Server], etc.),
-//! api requests / responses (eg. [Deploy][api::execute::Deploy], [GetBuild][api::read::GetBuild]), and usage guides.
+//! It contains:
+//! - Definitions for the application [api] and [entities].
+//! - A [client][MonitorClient] to interact with the monitor core API.
+//! - Information on configuring monitor [core][entities::config::core] and [periphery][entities::config::periphery].
 //! 
-//! ## Configuration
+//! ## Client Configuration
 //! 
 //! The client includes a convenenience method to parse the monitor url and credentials from the environment:
 //! - MONITOR_ADDRESS
 //! - MONITOR_API_KEY
 //! - MONITOR_API_SECRET
 //! 
-//! ## Example
+//! ## Client Example
 //! ```
 //! dotenv::dotenv().ok();
 //!