Skip to content

[Docs] Add docs/glossary.md indexing first-mention terms - #10

Merged
Yunaik merged 1 commit into
ThinkFlowLab:mainfrom
ChaitanyaAIML-lab:contributions/issue-2
Sep 25, 2026
Merged

Yunaik merged 1 commit into
ThinkFlowLab:mainfrom
ChaitanyaAIML-lab:contributions/issue-2

Conversation

@ChaitanyaAIML-lab

Copy link
Copy Markdown
Contributor

Summary

The documentation uses a set of domain terms defined across different pages. Readers landing mid-page lacked a single lookup reference.

Changes

  • Created docs/glossary.md defining key terms with one-line descriptions and links to defining documentation pages:
    • System 1 decision model, decision model, head -> docs/decision-models.md
    • model slot, front, rail -> docs/architecture.md
    • arm -> docs/benchmarks.md
    • tick, replay, episode, labelled set -> evals/README.md
  • Added docs/glossary.md to the Docs list in README.md.
  • Kept all first-mention glosses across existing documentation pages intact.

Verification

  • uv run ruff format --check . (exit code 0)
  • uv run ruff check . (exit code 0)
  • uv run ty check (exit code 0)
  • uv run pytest -q (482 passed, 41 skipped, 66 subtests passed, exit code 0)
  • Relative documentation link integrity verified locally

Fixes #2

- Define System 1 decision model, decision model, model slot, front, rail, head, arm, tick, replay, episode, and labelled set in docs/glossary.md.
- Link each glossary term directly to the documentation page defining it.
- Reference docs/glossary.md under the Docs section in README.md.
@Yunaik
Yunaik merged commit b7560b1 into ThinkFlowLab:main Sep 25, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Glossary: the terms the docs gloss on first mention

2 participants