grokbot_api/guide.rs
1//! Topic guides.
2//!
3//! Each submodule renders one of the Markdown guides that ship with the crate (the same
4//! files linked from the README). They contain no code; their examples are compiled as
5//! doctests.
6//!
7//! | Guide | Topic |
8//! |---|---|
9//! | [`sessions`] | Gateway sessions, EnsureSandBox, 401/417 re-authentication, `ClientOptions` |
10//! | [`policy`] | Which hosts may receive credentials |
11//! | [`agents`] | Bots, groups and team agents |
12//! | [`messaging`] | Sending prompts and delivery states |
13//! | [`transcripts`] | Paging transcripts and parsing entries |
14//! | [`approvals`] | Detecting and resolving approval cards |
15//! | [`workflows`] | Skills (workflows) |
16//! | [`errors`] | Error variants and secret redaction |
17//! | `desktop` | Reading the desktop app's session (`desktop-session` feature) |
18//! | [`protocol`] | Wire protocol reference |
19//!
20//! Links between guides point at the Markdown files in the repository.
21
22#[doc = include_str!("../SESSIONS.md")]
23pub mod sessions {}
24
25#[doc = include_str!("../POLICY.md")]
26pub mod policy {}
27
28#[doc = include_str!("../AGENTS.md")]
29pub mod agents {}
30
31#[doc = include_str!("../MESSAGING.md")]
32pub mod messaging {}
33
34#[doc = include_str!("../TRANSCRIPTS.md")]
35pub mod transcripts {}
36
37#[doc = include_str!("../APPROVALS.md")]
38pub mod approvals {}
39
40#[doc = include_str!("../WORKFLOWS.md")]
41pub mod workflows {}
42
43#[doc = include_str!("../ERRORS.md")]
44pub mod errors {}
45
46#[cfg(feature = "desktop-session")]
47#[cfg_attr(docsrs, doc(cfg(feature = "desktop-session")))]
48#[doc = include_str!("../DESKTOP.md")]
49pub mod desktop {}
50
51#[doc = include_str!("../PROTOCOL.md")]
52pub mod protocol {}