Skip to content

feat: Add "For LLMs" page with outdated syntax guide#296

Merged
magnus-madsen merged 1 commit intomasterfrom
docs/for-llms
Feb 27, 2026
Merged

feat: Add "For LLMs" page with outdated syntax guide#296
magnus-madsen merged 1 commit intomasterfrom
docs/for-llms

Conversation

@magnus-madsen
Copy link
Member

@magnus-madsen magnus-madsen commented Feb 27, 2026

Summary

  • Adds a new For LLMs page under Additional Information, aimed at LLMs and AI assistants that generate Flix code
  • Documents 10 key syntax changes from older Flix versions found in research papers, talks, and blog posts:
    • main signature (Unit \ IO, no args)
    • Effect syntax (\ not &)
    • No primitive effects (FsRead, Net, etc. → IO)
    • No do keyword for effect operations
    • Handler syntax (with handler not just with)
    • Java types must be imported
    • No old-style body-level import for Java methods
    • Annotations are uppercase (@Test not @test)
    • No rel/lat declarations for Datalog
    • inject requires arity (Edge/2 not Edge)
  • Each section shows old (invalid) vs current (correct, as of Flix 0.68.0) syntax with examples

Test plan

  • Verify the book builds with mdbook build
  • Check the new page renders correctly in the sidebar under Additional Information
  • Verify all internal links resolve

🤖 Generated with Claude Code

Add a new page under Additional Information aimed at LLMs and AI
assistants that may have been trained on older Flix code from research
papers, talks, and blog posts. The page documents key syntax changes
including: main signature, effect syntax (\ not &), removal of
primitive effects, no do keyword, handler syntax, Java import changes,
uppercase annotations, and Datalog declaration changes.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@magnus-madsen magnus-madsen changed the title Add "For LLMs" page with outdated syntax guide feat: Add "For LLMs" page with outdated syntax guide Feb 27, 2026
@magnus-madsen magnus-madsen merged commit a56c519 into master Feb 27, 2026
1 check passed
@magnus-madsen magnus-madsen deleted the docs/for-llms branch February 27, 2026 19:36
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