Log inGet started
World

Builtin Library

Branchmain
Branchesmainpublish
Commitdd348ac6c3

README.md

guides.list

The catalogue, README first. This is what a session opens with when it has neither a path to read nor a question to search.

It covers the .guide assets — built-in, package-shipped and world-authored — and the asset types, which answer under types/<name>. Every path it returns is a path guides.read resolves.

Tiers

The depth is the caller's to spend, because tiers 2 and 3 read every guide in the list and a whole catalogue at full depth is a large answer.

  • Tier 1 (the default) is paths alone.
  • Tier 2 adds kind — guide or assettype — and summary, the guide's own first heading or first prose line, so the list says what each one is rather than only what it is called.
  • Tier 3 adds vfsPath, the file behind the guide, and aliases, the other spellings it answers to.

assetType narrows to one of the two kinds, and limit caps the rows; total always reports how many the catalogue holds, so a capped list still says what it left out.

Finding one

Enumerating is the wrong tool for "which guide explains X". guides.search ranks by what a guide means, so a question asked in your own words reaches the guide that answers it without sharing its wording.