# `AshLua.EvalActions.Run.Docs`
[🔗](https://github.com/ash-project/ash_lua/blob/v0.1.0/lib/ash_lua/eval_actions/run/docs.ex#L5)

Implementation backing the synthesized `:docs` action.

Returns markdown for the scoped Lua surface, in one of three modes:

  * **`search` set** — runs `AshLua.Docs.search/2` over the scoped surface
    and returns a ranked list of matches. The list is intended as a
    discovery aid; follow up with the same action using `name` set to one
    of the returned ids.
  * **`name` set** — resolves against the scoped manifest and returns the
    focused page (callable, record-type, named-type, or topic).
  * **neither set** — returns the full scoped page (`AshLua.Docs.full_doc/1`).

Passing both `name` and `search` is an error.

---

*Consult [api-reference.md](api-reference.md) for complete listing*