pelopo
Hi,
Oficial docs got this wonderful feature to download the ePub version that we can chuck to our kindles and read it. Now we are in the age of AI coding assistants and format like ePub is something LLMs do not like to see as context. What they do like is markdown, xml, json.
I propose in the similar fashion to ePub, to have a markdown version of the full docs of Phoenix and LiveView so the scrapers or manually can automatically and easily download the markdown to use as context for AI Coding tools.
Maybe some type of versioning and update daytime markers would be nice too.
Thanks
Where Next?
Trending in Proposals: Ideas
Other Trending Topics
Latest Phoenix Threads
Latest on Elixir Forum
Sponsor Spotlight
Catch errors, track performance, monitor hosts and more.
Categories:
Sub Categories:
Forums
Popular Tags
- #ecto
- #liveview
- #troubleshooting
- #learning-elixir
- #deployment
- #library
- #erlang
- #testing
- #genserver
- #mix
- #absinthe
- #remote-other
- #otp
- #plug
- #how-to-question
- #macros
- #postgres
- #elixirconf
- #channels
- #exunit
- #discussion
- #code-sync
- #javascript
- #podcasts
- #onsite
- #dialyzer
- #docker
- #authentication
- #umbrella
- #full-time-contract
- #podcasts-by-brainlid
- #ecto-query
- #blog-post
- #elixir-ls
- #ai
- #elixirconf-us
- #phoenix_html
- #iex
- #graphql
- #genstage
- #websockets
- #supervisor
- #advent-of-code
- #distillery
- #processes
- #api
- #forms
- #hex
- #security
- #metaprogramming
Our Sponsors
Build Elixir applications with speed and confidence.
Supporting innovation across the BEAM ecosystem.
We build reliable cloud platforms for business-critical systems.
Catch errors, track performance, monitor hosts and more.
Elixir, Erlang & BEAM conferences from Code Sync - join us in 2026!
Practical resources that improve the lives of professional developers.
Master modern tools, write cleaner code, and tackle real-world challenges.
Producing high quality Elixir screencasts since 2017.
The team behind Membrane, Popcorn, LiveDebugger. Available for hire.
Courses that'll move you from confusion to "Aha, now I get it!"
Showing Posts 1 to 5- Show Best Posts
- Show All (oldest first)
- Show All (newest first)
mayel
I had the same thought and your post pushed me to make a quick proof-of-concept:
https://github.com/elixir-lang/ex_doc/pull/1976
mayel
I’m thinking a ZIP can be useful when you want to provide the whole context, but being able to copy just a module or even a function’s docs from the web UI could be handy too?
pelopo
Thanks, I think it’s a great start. Not sure about the zip though. It reduces the size but complicates the actual end goal - getting the context. It adds friction.
Usually, in AI coding tools like Cursor or the terminal based “aider” you just provide the url and the tool scrapes it and the more complex it is to scrape, the lesser quality results you get. Therefore making people think Elixir is not easy and even AI tools can’t help much.
My thinking is if you make an AI ready content ( like markdown version of the HTML doc page) easy to be accessed by these AI coding scrapers, the higher quality will be the LLM model’s reply.
It literally could be just an additional link for a markdown version ( next to the ePub version link)
pelopo
For now I’m using the conversion with
pandocthrough terminal after downloading the epub version first.steffend
Related: Can we create an llms.txt file for Phoenix? Similar to Svelte's llms.txt file · Issue #6076 · phoenixframework/phoenix · GitHub
For now, I don’t think Phoenix itself should do anything here. The ExDoc PR was already linked and there’s also https://hex2txt.fly.dev/.