README.md — sigil-docs

1# sigil-docs

3> **Archived:** This standalone package has been replaced by the

4> `sigil-help` workspace package in `codeberg:sigil/sigil`. The historical

5> repository and all tags are retained for provenance; do not publish new

6> releases from this repository.

8Documentation lookup and search tooling for Sigil projects.

10## Overview

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

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

14are generated by the Sigil compiler during compilation.

16Sub-modules:

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

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

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

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

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

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

25## Usage

27```scheme

28(import (sigil docs))

30;; Look up an export's docs

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

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

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

35```

37## Building and testing

39```sh

40sigil deps install

41sigil build

42sigil test --report

43```

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

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

48```sh

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

50```

52## License

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