Put pages into groups, include tutorials #1007
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Noarkhh
added
the
no-changelog
Noarkhh
force-pushed
the
restructure-docs
branch
from
6f4372d to
c33ddb6
Compare
mat-hek
reviewed
Oct 27, 2025
Member
mat-hek
left a comment
mat-hek
left a comment
There was a problem hiding this comment.
Generating docs throws warnings
Comment on lines
+166
to
+176
| "Get started with Membrane": | ||
| Path.wildcard("guides/membrane_tutorials/get_started_with_membrane/*.md"), | ||
| "Intro to pipelines": Path.wildcard("guides/membrane_tutorials/basic_pipeline/*.md"), | ||
| "Intro to pipelines - advanced concepts": | ||
| Path.wildcard("guides/membrane_tutorials/basic_pipeline_extension/*.md"), | ||
| "Creating plugins": Path.wildcard("guides/membrane_tutorials/create_new_plugin/*.md"), | ||
| "Useful concepts": Path.wildcard("guides/useful_concepts/*.md"), | ||
| H264: Path.wildcard("guides/membrane_tutorials/h264/*.md"), | ||
| Broadcasting: Path.wildcard("guides/membrane_tutorials/broadcasting/*.md"), | ||
| Glossary: Path.wildcard("guides/membrane_tutorials/glossary/*.md"), | ||
| Upgrading: Path.wildcard("guides/upgrading/*.md") |
Member
There was a problem hiding this comment.
- Can we generate this automatically?
- I thought you merged the pipelines tutorials into one?
Contributor
Author
There was a problem hiding this comment.
- We can but I'm not sure if we should, this way it's easier to modify the titles and you have more fine grained control
- I did, I removed this group in the next PR, but if a group has no contets it's not being displayed, so dont worry, it's not visible. About the warnings, they are thrown because
membrane_tutorialfixing them isn't merged yet, and the submodule in guides points to the master branch.
mat-hek
approved these changes
Oct 29, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
membrane_tutorialsin the docsToDo: