A glossary page for Grit's own terms, linked on first use

Open Beginner friendly
#242 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
62/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Active
Tech stack
go, html, markdown, nextjs, react, typescript
Domain
documentation

Research direction

Start with TERMINOLOGY.md, which already defines the terms, and check whether a data file or the docs site already exposes them. Build a /docs/glossary page with one sentence per term and a shared <Term> component used on the Start and Quick Start pages, then add the glossary to llms.txt. Done when those pages link first mentions and the glossary is generated from the same source as TERMINOLOGY.md.

Written by the indexing model from the issue text.

Description

documentation

New readers meet triple, double, battery, resource, blueprint, tech kit, Sentinel, Pulse, Scout, policy, row rule, seeder, injection anchor, framework-owned file and more before any of them is defined. TERMINOLOGY.md already settles these words for contributors.

Proposal

  • /docs/glossary: one plain-English sentence per term, plus a link to its full page. Build it from TERMINOLOGY.md (or one data file both read) so the two can't drift.
  • A small <Term> component that links a word to its glossary entry, used on the first mention on the Start and Quick Start pages.
  • Include the glossary in llms.txt.

Filed from a docs and developer-experience review of gritframework.dev and this repository (November 2026).


Generated by Claude Code

Dominant language
Go
Stars
152
Forks
20
Avg merge
1d 49m
Merged PRs (30d)
5

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from MUKE-coder/grit

All issues in MUKE-coder/grit

Similar issues

More Go issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.