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

RFE: Setting up readthedocs (and extend documentation) #669

Open
engelmi opened this issue Nov 27, 2024 · 1 comment
Open

RFE: Setting up readthedocs (and extend documentation) #669

engelmi opened this issue Nov 27, 2024 · 1 comment

Comments

@engelmi
Copy link
Member

engelmi commented Nov 27, 2024

Currently, the existing documentation for QM is limited to the directory docs/ directory, which provides documentation for users to some degree. However, instead of using plain READMEs in the repository it would be better to have a dedicated webpage (e.g. via readthedocs) for user documentation. This can then be easily extended, e.g. by showing how ti enable Wayland in QM, maintained and it provides a nice way of presentation for users of QM.

Other projects like BlueChi (see https://bluechi.readthedocs.io/en/latest/ ) and tmt (https://tmt.readthedocs.io/en/stable/) use readthedocs, thus I'd suggest using it as well. Setting up readthedocs in QM (with the currently existing doc content) would be the first step. Subsequently, the documentation can be extended and refined.
Depending on capacity, I'd be up for implementing the readthedocs setup.
@dougsland @Yarboa @pypingou What do you think?

@Yarboa
Copy link
Collaborator

Yarboa commented Nov 27, 2024

Better documentation high chances for more contribution.
@kleinffm do you have a bandwidth to assist in that ticket?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants