Skip to content

feat: add FileSystem page#308

Merged
magnus-madsen merged 3 commits intomasterfrom
feat/add-filesystem-page
Mar 22, 2026
Merged

feat: add FileSystem page#308
magnus-madsen merged 3 commits intomasterfrom
feat/add-filesystem-page

Conversation

@magnus-madsen
Copy link
Copy Markdown
Member

@magnus-madsen magnus-madsen commented Mar 22, 2026

Summary

  • Add new filesystem.md page covering all Fs effects (FileRead, FileWrite, FileStat, DirList, Glob, FileSystem), middleware, composing middleware, IoError, and the effect hierarchy
  • Update library-effects.md to list FileRead/FileWrite/FileStat alongside FileSystem
  • Update introduction.md to replace outdated FileWriteWithResult example with Http composing middleware example
  • Update next-steps.md to use Fs.FileRead with default handlers instead of outdated FileReadWithResult.runWithIO

Test plan

  • Verify the book builds with mdbook build
  • Check that all code examples match current Flix syntax
  • Verify internal links (e.g. #the-effect-hierarchy) resolve correctly

🤖 Generated with Claude Code

magnus-madsen and others added 3 commits March 22, 2026 07:15
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- Reword filesystem.md to use informal "we" language throughout
- Add IoError explanation with abbreviated ErrorKind table
- Move Effect Hierarchy section after Middleware Summary
- Move Reading a File before Writing a File
- Add notes about IO effect and combined effect sets
- Update introduction.md to use Http composing middleware example
- Update next-steps.md to use FileRead with default handlers
- Update library-effects.md with line-broken effect names

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- Remove Size Rotation section
- Fix middleware composition description (innermost handler runs first)
- Fix incorrect Clock effect mention in composing middleware section
- Reword In-Memory Filesystem and Memory Overlay introductions
- Add scroll hint to middleware summary table

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@magnus-madsen magnus-madsen merged commit 1b7f546 into master Mar 22, 2026
1 check passed
@magnus-madsen magnus-madsen deleted the feat/add-filesystem-page branch March 22, 2026 07:14
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