crates/doc/README.md
Solidity documentation generator powered by solar.
forge-doc walks the solar HIR (High-level Intermediate Representation) and emits
vocs-flavoured MDX pages suitable for publishing as a documentation site.
DocBuilder: entry point, configures source roots, output directory, and optional
Git/deployment metadata, then calls build() to generate the docs.render: AST → MDX conversion with HIR lookups. Handles contracts, functions, structs,
enums, errors, events, and UDVTs, including explicit @inheritdoc and implicit NatSpec
inheritance, plus inline {Link} rewriting. Depends on HIR for inheritance and cross-reference
resolution.hir_ext: HIR-aware helpers including name-to-page mapping, inheritance links, effective
NatSpec resolution, and inline link replacement.utils: small utility functions, git_source_url and read_deployments.vocs: vocs site scaffolding, generates vocs.config.ts, vocs.sidebar.ts
(always regenerated, imported by vocs.config.ts), package.json, .gitignore, and
src/pages/index.mdx.