Skip to content

docs: add stdlib and effect-oriented guidance to for-llms.md - #319

Merged
magnus-madsen merged 1 commit into
masterfrom
docs/for-llms-stdlib-and-effects
Jun 25, 2026
Merged

docs: add stdlib and effect-oriented guidance to for-llms.md#319
magnus-madsen merged 1 commit into
masterfrom
docs/for-llms-stdlib-and-effects

Conversation

@magnus-madsen

Copy link
Copy Markdown
Member

Adds four new items to the For LLMs page (src/for-llms.md), grouped near the top as authoritative-source / preference guidance:

  • Learn the Standard Library from api.flix.dev — don't unpack flix.jar; use the online API docs (typically stable across releases).
  • Prefer the built-in Util.Json module over the third-party flix-json package; links to api.flix.dev/Util.Json.html.
  • Use effect-oriented programming — program against (a) Standard Library effects or (b) your own effects, handled near main; links to the library-effects docs.
  • Prefer Standard Library effects over Java interop — avoid unsafe/direct Java calls when an existing effect (file I/O, HTTP, network I/O, …) does the job.

🤖 Generated with Claude Code

Add new items to the "For LLMs" page:
- Learn the Standard Library from api.flix.dev (don't unpack flix.jar)
- Prefer the built-in Util.Json module over the flix-json package
- Use effect-oriented programming (library or own effects, handled near main)
- Prefer Standard Library effects over Java interop

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@magnus-madsen
magnus-madsen merged commit fe62874 into master Jun 25, 2026
1 check passed
@magnus-madsen
magnus-madsen deleted the docs/for-llms-stdlib-and-effects branch June 25, 2026 09:40
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.

1 participant