Skip to content

docs: add missing packages and improve wifi configuration#3637

Open
maurerle wants to merge 5 commits intofreifunk-gluon:mainfrom
ffac:improve_docs
Open

docs: add missing packages and improve wifi configuration#3637
maurerle wants to merge 5 commits intofreifunk-gluon:mainfrom
ffac:improve_docs

Conversation

@maurerle
Copy link
Member

@maurerle maurerle commented Dec 7, 2025

I hope that these changes are not too controversial.. :)

  • add docs on building docs
  • add docs for gluon-mesh-vpn-sqm
  • add docs for gluon-wireless-encryption-wpa3
  • improve section on wireless roles
  • improve docs to layer3 multicast setup from @T-X

closes #3131

@T-X
Copy link
Contributor

T-X commented Dec 7, 2025

Many thanks for the work, for a voluntary community project it's so important to have good documentation, to understand but also to allow others to jump in if needed.

For the SQM package I was wondering, does it "only" reduce latency / bufferbloat? Or could it also enable some fairness between streams? For example in a setup with three fully meshed nodes A, B, C, and C provides an uplink via fastd: Would each client device / client MAC address on A and B get the same bandwidth over the fastd tunnel? Or is that not possible yet, because CAKE is not capable to look inside the batman-adv header? (But could maybe also be discussed or added later, don't want to derail this PR.)

@neocturne neocturne self-requested a review December 9, 2025 19:51
@neocturne neocturne added this to the v2025.1 milestone Dec 9, 2025
@neocturne
Copy link
Member

There are still a few unresolved comments (2 of which Github had helpfully hidden...) - and I just unresolved one that I consider important. We can merge this after everything has been resolved and backport to 2025.1.x later.

@rotanid rotanid modified the milestones: v2025.1, v2026.1 Dec 31, 2025
@maurerle maurerle added the 2. status: waiting-on-review Awaiting review from the assignee but also interested parties. label Jan 16, 2026
@maurerle
Copy link
Member Author

The open discussions are fixed now - so this should be good.

docs/README.md Outdated
This is set up using:

0. Create environment using `python -m venv .venv`
1. Activate the environment using `source ./.venv/bin/activate`
Copy link
Member

Choose a reason for hiding this comment

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

This does not work. The venv must not be located inside the docs directory, or Sphinx will attempt to build parts of the venv as doc files.

Copy link
Member

Choose a reason for hiding this comment

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

Also, using . instead of source is preferable, as it is compatible with more shells (. is POSIX shell, while source is a bash extension supported by many, but not all shells)

Copy link
Member

Choose a reason for hiding this comment

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

Choosing a path like .venv and adding it to exclude_patterns in conf.py and .gitignore would be an option. Might just call it venv though, no need to hide it.

Copy link
Member Author

Choose a reason for hiding this comment

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

I changed instructions to create the venv in the repo root - what do you think about this?

Copy link
Member

Choose a reason for hiding this comment

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

This is how I've been building the docs usually, but it may be cleaner to provide a way to keep the venv in the docs directory (may also reduce confusion if we ever add another requirements.txt for a separate Python environment) - as mentioned, this would just require adding the designated venv directory to exclude_patterns.

Maybe _venv would be a good name then, to make it match other special directories like _build?

@neocturne neocturne added 2. status: waiting-on-author Waiting on some action from the author and removed 2. status: waiting-on-review Awaiting review from the assignee but also interested parties. labels Feb 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

2. status: waiting-on-author Waiting on some action from the author 3. topic: batman-adv 3. topic: docs Topic: Documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

missing documentation for packages

4 participants