Overview

This module defines the codelogician doc CLI (implemented with Typer + Rich) for working with the CodeLogician documentation corpus:

Guides: articles on writing IML and using ImandraX
Applications: tutorials for formalizing domains with ImandraX and reasoning about the resulting models
Examples: worked IML examples
Ref: IML / ImandraX built-in modules and API reference entries
Errors: error catalog (planned / implied by help text)
Approximations: a catalog of function approximations (planned / implied by help text)

Command group: `codelogician doc`

`codelogician doc contents`

Purpose: Print a table-of-contents for available documentation.

Example:

codelogician doc contents

`codelogician doc view <desc>`

Purpose: View a specific chapter/topic by fuzzy-ish matching on a description.

Behavior:

Looks up a topic with doc.find_topic(desc)
If no match: prints Found no topic matching the title
Else: prints the matched doc file/content

Example:

codelogician doc view "IML basics"
codelogician doc view "SMT caveats"

`codelogician doc search <query> [topic]`

Purpose: Search documentation.

Allowed topics:

all, guide, api, examples, errors, applications

Note: Topic is currently validated but not used to filter results.

Example:

codelogician doc search "decomposition"

`codelogician doc prompt`

Purpose: Emit a single LLM/Agent prompt describing how to use IML and ImandraX.

Example:

codelogician doc prompt > iml_prompt.txt

`codelogician doc dump <dir_path>`

Purpose: Dump IML overview, API reference, and hands-on guides to markdown files. Targeted at both LLM and human readers.

Example:

codelogician doc dump ./docs_out

Subcommand group: `codelogician doc ref`

`codelogician doc ref summary`

Summarizes available IML modules and entry counts.

`codelogician doc ref view [module]`

Lists API reference entries, optionally filtered by module name.

Cheat Sheet

codelogician doc contents
codelogician doc view "TLS handshake"
codelogician doc search "counterexample"
codelogician doc prompt
codelogician doc dump ./docs_out
codelogician doc ref summary
codelogician doc ref view List