README.md — sigil-docs

1# sigil-docs

3Documentation lookup and search tooling for Sigil projects.

5## Overview

7`(sigil docs)` provides JSON-based documentation lookup for REPL inline help

8and tooling integration (LSP hover, MCP tools, format hints). Doc JSON files

9are generated by the Sigil compiler during compilation.

11Sub-modules:

13- `(sigil docs)` — top-level surface re-exporting the lookup API

14- `(sigil docs lookup)` — JSON-based doc lookup

15- `(sigil docs types)` — doc record type definitions

16- `(sigil docs search)` — documentation search across modules

17- `(sigil docs index)` — doc-index assembly

18- `(sigil docs packages)` — package-level doc lookup

20## Usage

22```scheme

23(import (sigil docs))

25;; Look up an export's docs

26(get-export-details '(sigil string) 'string-split)

28;; Get a module's top-level description

29(get-module-description '(sigil docs))

30```

32## Building and testing

34```sh

35sigil deps install

36sigil build

37sigil test --report

38```

40For local development against an unreleased sigil-lang / sigil-args /

41sigil-ansi / sigil-json checkout, use `dev-redirects.sgl`:

43```sh

44sigil deps install --redirects ./dev-redirects.sgl

45```

47## License

49BSD-3-Clause. See [LICENSE](LICENSE).