Add a "Limitations" section to the README

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

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
1-3 hours
Newbie friendliness
88/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Quiet
Domain
documentation

Research direction

Open the README and locate the "What's in this MVP" section. Add a nearby "Limitations" section covering each of the five listed limitations, preserving the factual scope from the issue. Done means the section appears before "What's in this MVP" and all listed limitations are represented clearly.

Written by the indexing model from the issue text.

Description

Per 2026-05-26 review with Matthew: the app should be presented transparently with its known limits so users can apply their own judgement.

To cover:

  • No feeding trials have validated formulated diets against a reference diet.
  • No model for ingredient interactions, palatability, or physical pellet/extrusion properties (water content, durability).
  • No batch-level testing for anti-nutritional factors or nutrient composition — the engine trusts the FICD/ASNS reference values.
  • Toxin thresholds use literature values; small-scale millers cannot measure them per batch.
  • Strain-level requirements (e.g. GIFT vs generic Nile Tilapia) are not differentiated.

Place near the top of the README, before "What's in this MVP."

Dominant language
Python
Stars
1
Forks
2
No merged PRs in 30d

Contributor guide

Open the contributing guide

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.

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.