[sake92]

Summary

• add a FlatMark documentation site organized into tutorials, how-tos, reference, and explanation
• document the http4s + Iron setup, incremental regeneration, supported backends, and current limitations
• explain why OpenAPI4s is a simpler contract-first fit than Scala-first or overwrite-based alternatives
• deploy the rendered site to GitHub Pages on documentation changes
• make Coursier examples deterministic with an explicit Scala 2.13.16 selection

Why

The README currently has to serve onboarding, operational guidance, reference, and design explanation at once. That makes important integration details hard to discover and leaves no scalable home for realistic examples. The site gives each kind of documentation a focused place while keeping the README useful as the project landing page.

The explicit Coursier Scala version prevents :: resolution from selecting the wrong binary suffix; the existing unqualified launch commands are not reliable enough for a Scala 2.13 CLI. The http4s guide also shows the required ErrorHandling wrapper so Iron decoding failures become usable 400/422 responses rather than leaving users with incomplete plumbing.

Validation

• FLATMARK_BASE_URL=https://sake92.github.io/openapi4s flatmark build -i docs
• rendered internal-link audit
• workflow YAML parse
• git diff --check

[coderabbitai]

Caution

Review failed

The pull request is closed.

Finishing Touches

📝 Generate docstrings

• Commit to this branch
• Create a new PR

• Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}