Skip to content

docs: Clarify Quick Start: fitness_functions.yaml vs config.py#8

Draft
tjirab wants to merge 2 commits into
mainfrom
docs/clarify-quick-start-config
Draft

docs: Clarify Quick Start: fitness_functions.yaml vs config.py#8
tjirab wants to merge 2 commits into
mainfrom
docs/clarify-quick-start-config

Conversation

@tjirab

@tjirab tjirab commented Jun 24, 2026

Copy link
Copy Markdown
Owner

Summary

  • Clarifies that fitness_functions.yaml is where users put fitness function settings (thresholds, rule toggles, etc.)
  • Marks project config.py as optional SQLMesh loader wiring, needed only for native SQLMesh commands (sqlmesh plan, etc.), not for sqlmesh-ff lint
  • Explicitly states that fitness settings do not belong in config.py

Test plan

  • README renders correctly
  • Reviewer confirms wording matches intended setup flow

Made with Cursor

Quick start previously implied config.py holds configuration; make clear
that YAML is the editable FF config and project config.py is optional
SQLMesh loader wiring for native sqlmesh commands.

Co-authored-by: Cursor <cursoragent@cursor.com>
@tjirab tjirab changed the title Clarify Quick Start: fitness_functions.yaml vs config.py docs: Clarify Quick Start: fitness_functions.yaml vs config.py Jun 25, 2026
@github-actions github-actions Bot added the docs label Jun 25, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant