llms.txt: config-schema Required column is a pointer-kind guess (from #2608 review)
- Dominant language
- Go
- Stars
- 610
- Forks
- 63
- Avg merge
- 12h 28m
- Merged PRs (30d)
- 57
Description
Non-blocking M3 from the #2608 review. `cmd/conduit/internal/llmsgen/configschema.go:122` sets `Required = f.Type.Kind() != reflect.Pointer`, so every non-pointer config field (name, status, description, …) renders `Required: yes` in llms-full.txt. Requiredness isn't encoded in these structs (no validate tag) — it's enforced by config validation — so this mislabels optional fields as required, which is actively misleading for the agent-facing reference. Fix: drop the Required column for the config structs (keep it for connector params, which use real `config.ValidationTypeRequired`), or relabel/caveat it. Connector-param requiredness (connectors.go isRequired) is correct and unaffected.
Contributor guide
Research direction
Start at cmd/conduit/internal/llmsgen/configschema.go:122 and inspect how config structs produce the Required column in llms-full.txt. Compare that behavior with connector-param requiredness in connectors.go, especially isRequired. Done means config fields are no longer misleadingly marked required while connector-param requiredness remains unchanged.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 74/100