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

Rewrite all documentation #1936

Draft
wants to merge 13 commits into
base: main
Choose a base branch
from
Draft

Rewrite all documentation #1936

wants to merge 13 commits into from

Conversation

ecdye
Copy link
Contributor

@ecdye ecdye commented Dec 20, 2024

As has been mentioned many times, the openHABian documentation is poorly
written and often comes across in the wrong way. This is an attempt to
start fresh.

The goal is to keep the documentation clear, simple, and easy to follow.
All features should be fully documented and clear. Additionally the
expectations for what is supported should be clear, without making the
wrong impression on the end user, being overly wordy, or harsh.

Basically, make the documentation as great as the rest of openHABian.

Signed-off-by: Ethan Dye <mrtops03@gmail.com>
@ecdye ecdye added the documentation Relating to documentation label Dec 20, 2024
@mstormi
Copy link
Contributor

mstormi commented Dec 20, 2024

I believe you already recently 'softened' the HW requirements part and this https://github.com/openhab/openhabian/blob/main/docs/openhabian.md#3264-bit-support

What got lost along that way was that users should not be running 64 bit OS or java ob machines with 1GB.
Please prominently re-add a warning not to do that.

Signed-off-by: Ethan Dye <mrtops03@gmail.com>
Signed-off-by: Ethan Dye <mrtops03@gmail.com>
Signed-off-by: Ethan Dye <mrtops03@gmail.com>
Signed-off-by: Ethan Dye <mrtops03@gmail.com>
Signed-off-by: Ethan Dye <mrtops03@gmail.com>
Signed-off-by: Ethan Dye <mrtops03@gmail.com>
Signed-off-by: Ethan Dye <mrtops03@gmail.com>
@ecdye
Copy link
Contributor Author

ecdye commented Dec 25, 2024

@openhab/webui-maintainers Can you help me figure out how to make the sidebar have a dropdown to access a few subdocs like openHABian specific troubleshooting or more detailed feature guides?

Signed-off-by: Ethan Dye <mrtops03@gmail.com>
@florian-h05
Copy link
Contributor

The sidebar structure is defined in the docs repo:
https://github.com/openhab/openhab-docs/blob/main/.vuepress/docs-sidebar.js

BTW, rather ping the doc maintainers instead of us UI maintainers.

Merry Christmas to you 🎄

@ecdye
Copy link
Contributor Author

ecdye commented Dec 25, 2024

The sidebar structure is defined in the docs repo:

https://github.com/openhab/openhab-docs/blob/main/.vuepress/docs-sidebar.js

Awesome, thanks!

BTW, rather ping the doc maintainers instead of us UI maintainers.

Whoops, I'm sorry, I thought I even double checked, but I guess I wasn't looking close enough.

Merry Christmas to you 🎄

Merry Christmas!

Signed-off-by: Ethan Dye <mrtops03@gmail.com>
Signed-off-by: Ethan Dye <mrtops03@gmail.com>
ecdye added a commit to ecdye/openhab-docs that referenced this pull request Dec 26, 2024
Depends openhab/openhabian#1936

Signed-off-by: Ethan Dye <mrtops03@gmail.com>
@stefan-hoehn
Copy link

Can you help me figure out how to make the sidebar

Did you manage to create it or do you still need help? (I saw openhab/openhab-docs#2434)

@ecdye
Copy link
Contributor Author

ecdye commented Dec 26, 2024

Did you manage to create it or do you still need help? (I saw openhab/openhab-docs#2434)

I think that I got it, I just need to finish making all the changes here first.

Signed-off-by: Ethan Dye <mrtops03@gmail.com>
Signed-off-by: Ethan Dye <mrtops03@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Relating to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants