Skip to content
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.

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

[docs] update package, features and config mode docs #3188

Merged
merged 11 commits into from
Aug 7, 2024

Conversation

maurerle
Copy link
Member

This is a series of docs improvements created from #3131

I tested the docs using make -C docs html && python -m http.server --directory docs/_build/html.

I am open for additions and suggestions.
If I should split the commits into separate PRs I can sure do that too, though I did not want to create 5 PRs about docs.

I think that especially some visualizations to refer to are quiet important for users too, so I added two pictures.

@github-actions github-actions bot added 3. topic: docs Topic: Documentation 3. topic: config-mode This is about the configuration mode labels Feb 10, 2024
@maurerle
Copy link
Member Author

@skorpy2009 would you like to have a look at this, please?

@blocktrron
Copy link
Member

Pleases prefix and separate the commits by topic.

Copy link
Contributor

@herbetom herbetom left a comment

Choose a reason for hiding this comment

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

not a complete review, just what i noticed at a glance

docs/features/tls.rst Outdated Show resolved Hide resolved
docs/features/wlan-configuration.rst Outdated Show resolved Hide resolved
docs/package/gluon-web-cellular.rst Outdated Show resolved Hide resolved
docs/package/gluon-web-cellular.rst Outdated Show resolved Hide resolved
docs/package/gluon-web-network.rst Outdated Show resolved Hide resolved
docs/package/gluon-web-network.rst Outdated Show resolved Hide resolved
@neocturne neocturne self-requested a review April 9, 2024 19:41
@maurerle maurerle force-pushed the improve_docs branch 3 times, most recently from 2d67bc2 to 940b810 Compare April 16, 2024 05:56
@maurerle
Copy link
Member Author

maurerle commented Jul 9, 2024

I would like to get this merged :)
Is there anything else I should do or improve?

@maurerle
Copy link
Member Author

I update the PR to reflect to latest changes of the web-cellular package in #3307
See: https://github.com/freifunk-gluon/gluon/compare/68e431003d183ed474d9b552482f6aeeb0cb9a3c..ecc12e46d4e950c3f30e2dc8b7f9c97000aaa050

The build of the resulting docs can be found here:
https://gluon--3188.org.readthedocs.build/en/3188/ ("Details" link from the CI runs)

@maurerle maurerle requested review from grische and herbetom July 11, 2024 06:39
Copy link
Member

@rotanid rotanid left a comment

Choose a reason for hiding this comment

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

i'd merge it, if you revert your wlan/wifi change.
wifi is a trademark and we want to use wlan.
if there is something like "wifi", please change that one in turn to "wlan", but not the other way around.

@maurerle
Copy link
Member Author

maurerle commented Aug 7, 2024

Thanks @rotanid - I removed this commit through a rebase.
Lets merge?

@rotanid rotanid merged commit f729aac into freifunk-gluon:main Aug 7, 2024
10 checks passed
@maurerle maurerle deleted the improve_docs branch August 9, 2024 19:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3. topic: config-mode This is about the configuration mode 3. topic: docs Topic: Documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants