Skip to content

Publish Markdown and llms.txt docs with ExDoc 0.40.3 - #14

Closed
BobbieBarker wants to merge 1 commit into
phoenixframework:mainfrom
BobbieBarker:chore/ex-doc-0.40.3
Closed

BobbieBarker wants to merge 1 commit into
phoenixframework:mainfrom
BobbieBarker:chore/ex-doc-0.40.3

Conversation

@BobbieBarker

Copy link
Copy Markdown

Summary

  • require ExDoc 0.40.3 for development documentation
  • update the locked ExDoc documentation toolchain
  • preserve the existing HTML and EPUB outputs while adding native Markdown pages and llms.txt

Why this matters

ExDoc v0.40 added native Markdown output and llms.txt generation. Publishing those artifacts on HexDocs makes WebSock's documentation directly consumable by modern documentation retrieval tools, including docs-mcp-server, without scraping the HTML site. Broad library adoption is what makes this useful across the Elixir ecosystem.

After this merges, please publish or re-publish WebSock's documentation at your earliest convenience so the Markdown pages and llms.txt become available to the community.

Compatibility

WebSock's package runtime requirement remains unchanged. ExDoc is a development-only dependency with runtime: false, so it does not enter downstream runtime dependency graphs. Generating the documentation now requires Elixir 1.15 or later, as required by ExDoc 0.40.3.

Verification

  • unmodified baseline: mix docs generated HTML and EPUB, with no llms.txt or Markdown pages
  • changed build: mix docs generated HTML, EPUB, llms.txt, and 4 Markdown files
  • all 3 links emitted in llms.txt resolve to generated files
  • mix format --check-formatted
  • mix deps.unlock --check-unused
  • MIX_ENV=test mix compile --warnings-as-errors
  • MIX_ENV=test mix test — no tests defined
  • MIX_ENV=test mix credo --strict

@mtrudel

mtrudel commented Oct 27, 2026

Copy link
Copy Markdown
Member

Squashed a fix onto main for this - I purposely didn't want to pin ex_doc to ~> 0.y.z

@mtrudel mtrudel closed this Oct 27, 2026
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.

2 participants