Skip to content

Commit 4b57e56

Browse files
authored
Merge pull request #1134 from membraneframework/remove-skill-from-hexdocs-sidebar
Remove SKILL.md from the HexDocs sidebar
2 parents f121922 + 0bee0d6 commit 4b57e56

3 files changed

Lines changed: 18 additions & 4 deletions

File tree

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ You can also [follow Membrane on X (Twitter)](https://twitter.com/ElixirMembrane
2121

2222
If you already had a chance to use Membrane, we will be greateful if could fill out quick [survey](https://forms.gle/dgVDFHUD7CUGxU5VA) to help us improve framework and decide on what to do next.
2323

24+
For people who write Membrane code with AI assistants, we ship a [dedicated skill](#membrane-skill-for-ai-assistants) for them.
25+
2426
Membrane is maintained by [Software Mansion](https://swmansion.com).
2527

2628
## Quick start

mix.exs

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -107,19 +107,31 @@ defmodule Membrane.Mixfile do
107107
Membrane.RCMessage
108108
],
109109
groups_for_modules: groups_for_modules(),
110-
groups_for_extras: groups_for_extras()
110+
groups_for_extras: groups_for_extras(),
111+
before_closing_head_tag: &before_closing_head_tag/1
111112
]
112113
end
113114

115+
# Hides the AI skill page from the sidebar while keeping it published and linked from llms.txt.
116+
defp before_closing_head_tag(:html) do
117+
"""
118+
<style>
119+
#sidebar li:has(> a[href$="skill.html"]),
120+
#sidebar a[href$="skill.html"] { display: none; }
121+
</style>
122+
"""
123+
end
124+
125+
defp before_closing_head_tag(_format), do: ""
126+
114127
defp packages_in_ecosystem do
115128
{packages, _bindings} = Code.eval_file(@hex_packages_path)
116129
packages
117130
end
118131

119132
defp extras do
120133
[
121-
{"skills/membrane-framework/SKILL.md",
122-
[title: "Membrane Framework AI Skill", hidden: true]},
134+
{"skills/membrane-framework/SKILL.md", [title: "Membrane Framework AI Skill"]},
123135
"README.md",
124136
{"guides/llms/packages_list.md",
125137
[title: "Packages in the Membrane ecosystem", hidden: true]},

skills/membrane-framework/SKILL.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ alwaysApply: false
77

88
# Membrane Framework
99

10-
**Package**: `membrane_core` ~> 1.2 | **Docs**: https://hexdocs.pm/membrane_core/ | **Module index**: https://hexdocs.pm/membrane_core/llms.txt | **Demos**: https://github.com/membraneframework/membrane_demo | **All packages**: [packages_list.md](../../guides/llms/packages_list.md)
10+
**Package**: `membrane_core` ~> 1.3 | **Docs**: https://hexdocs.pm/membrane_core/ | **Module index**: https://hexdocs.pm/membrane_core/llms.txt | **Demos**: https://github.com/membraneframework/membrane_demo | **All packages**: [packages_list.md](../../guides/llms/packages_list.md)
1111

1212
## How to Approach Tasks
1313

0 commit comments

Comments
 (0)