Skip to content

Update ex_doc, add llms.txt support#5

Open
FelonEkonom wants to merge 1 commit intomasterfrom
update/ex-doc-llms-support-v2
Open

Update ex_doc, add llms.txt support#5
FelonEkonom wants to merge 1 commit intomasterfrom
update/ex-doc-llms-support-v2

Conversation

@FelonEkonom
Copy link
Copy Markdown
Member

Changes

  • Remove formatters: ["html"] from docs/0 — restores ex_doc default (generates HTML + Markdown)
  • Bump ex_doc to latest, update mix.lock
  • Bump package version (patch)
  • Add mix docs alias that prepends Membrane Core links to doc/llms.txt
  • Update package description

@FelonEkonom FelonEkonom requested review from mat-hek and varsill April 16, 2026 12:29
@FelonEkonom FelonEkonom self-assigned this Apr 16, 2026
Comment thread mix.exs
defp prepend_llms_links(_) do
path = "doc/llms.txt"

if File.exists?(path) do
Copy link
Copy Markdown

@varsill varsill Apr 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I assume that with new versions of ex_doc, llms.txt should always exist, is that right?
Let's add a warning when it doesn't exist since it indicates that something is misconfigured.

Comment thread mix.exs
if File.exists?(path) do
existing = File.read!(path)

header = "- [Membrane Core](https://hexdocs.pm/membrane_core/llms.txt)\n\n"
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's make sure that this line is appended only to "plugins" which depend on core (and not, e.g. to bundlex etc.)

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And a side question - shouldn't we "version" the membrane_core's llms.txt?
We could e.g. get membrane_core locked version using Mix.Dep.Lock.read() and use it in this link.
It's probably not that important, but I wanted to put it into discussion.

@varsill varsill self-requested a review April 17, 2026 09:16
Copy link
Copy Markdown

@varsill varsill left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please update version in README as well

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