Skip to content

Put pages into groups, include tutorials #1007

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Put pages into groups, include tutorials #1007

wants to merge 2 commits into from
+102 −54

Conversation

@Noarkhh
Copy link
Contributor

@Noarkhh Noarkhh commented Oct 15, 2025 •
edited
Loading

  • include membrane_tutorials in the docs
  • put separate tutorials and concepts into sections

ToDo:

  • H264 tutorial in Broadcasting is outdated
  • PNGs with transparent background dont look good on dark theme (that's also the case on the website)

@Noarkhh Noarkhh requested a review from mat-hek as a code owner October 15, 2025 09:50
@Noarkhh Noarkhh self-assigned this Oct 15, 2025
@Noarkhh Noarkhh added this to Smackore Oct 15, 2025
@Noarkhh Noarkhh moved this to In Progress in Smackore Oct 15, 2025
@Noarkhh Noarkhh added the no-changelog This label has to be added if changes from the PR are not meant to be placed in the CHANGELOG.md label Oct 15, 2025
@Noarkhh Noarkhh moved this from In Progress to In Review in Smackore Oct 22, 2025
mat-hek
mat-hek reviewed Oct 27, 2025
View reviewed changes
Copy link
Member

@mat-hek mat-hek left a comment

Choose a reason for hiding this comment

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

Generating docs throws warnings

mix.exs
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")
Copy link
Member

Choose a reason for hiding this comment

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

  • Can we generate this automatically?
  • I thought you merged the pipelines tutorials into one?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mat-hek mat-hek mat-hek left review comments

At least 1 approving review is required to merge this pull request.

Assignees

@Noarkhh Noarkhh

Labels

no-changelog This label has to be added if changes from the PR are not meant to be placed in the CHANGELOG.md

Projects

Smackore
Status: In Review

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@Noarkhh @mat-hek