You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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?
The text was updated successfully, but these errors were encountered:
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?
The text was updated successfully, but these errors were encountered: