docs: document all of the tui/tui2 and some other stuff

Automated pass; details in docs/documentation-pass.md and docs/documentation-status.md.
This commit is contained in:
Josh McKinney
2026-01-18 10:25:59 -08:00
parent b877a2041e
commit f75410fe33
253 changed files with 12778 additions and 1162 deletions
@@ -530,7 +530,7 @@ pub struct FuzzyFileSearchParams {
pub cancellation_token: Option<String>,
}
/// Superset of [`codex_file_search::FileMatch`]
/// Superset of `codex_file_search::FileMatch`.
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, JsonSchema, TS)]
pub struct FuzzyFileSearchResult {
pub root: String,
@@ -1065,12 +1065,12 @@ pub struct ThreadStartResponse {
pub struct ThreadResumeParams {
pub thread_id: String,
/// [UNSTABLE] FOR CODEX CLOUD - DO NOT USE.
/// UNSTABLE: FOR CODEX CLOUD - DO NOT USE.
/// If specified, the thread will be resumed with the provided history
/// instead of loaded from disk.
pub history: Option<Vec<ResponseItem>>,
/// [UNSTABLE] Specify the rollout path to resume from.
/// UNSTABLE: Specify the rollout path to resume from.
/// If specified, the thread_id param will be ignored.
pub path: Option<PathBuf>,
@@ -1111,7 +1111,7 @@ pub struct ThreadResumeResponse {
pub struct ThreadForkParams {
pub thread_id: String,
/// [UNSTABLE] Specify the rollout path to fork from.
/// UNSTABLE: Specify the rollout path to fork from.
/// If specified, the thread_id param will be ignored.
pub path: Option<PathBuf>,
@@ -1390,7 +1390,7 @@ pub struct Thread {
/// Unix timestamp (in seconds) when the thread was last updated.
#[ts(type = "number")]
pub updated_at: i64,
/// [UNSTABLE] Path to the thread on disk.
/// UNSTABLE: Path to the thread on disk.
pub path: PathBuf,
/// Working directory captured for the thread.
pub cwd: PathBuf,
@@ -2252,7 +2252,7 @@ pub struct FileChangeRequestApprovalParams {
pub item_id: String,
/// Optional explanatory reason (e.g. request for extra write access).
pub reason: Option<String>,
/// [UNSTABLE] When set, the agent is asking the user to allow writes under this root
/// UNSTABLE: When set, the agent is asking the user to allow writes under this root
/// for the remainder of the session (unclear if this is honored today).
pub grant_root: Option<PathBuf>,
}