Update the user manual
See original GitHub issueThe user manual is very old and incomplete.
Tasks for this ticket:
- Replace all screenshots with modern versions.
- Also create similar screenshots for Converse in fullscreen view_mode
- Expand the manual with more information (to be clarified)
Technical information
The user manual is in It’s in ./docs/source/manual.rst
in the Converse repo.
See: https://github.com/conversejs/converse.js/blob/master/docs/source/manual.rst
The manual is written in RestructuredText and generated with Sphinx
Sphinx uses Python, so you’ll need to set up a Python virtual environment with Buildout to manage dependencies.
Follow the instructions here: https://github.com/conversejs/converse.js/blob/master/docs/source/documentation.rst
Issue Analytics
- State:
- Created 5 years ago
- Reactions:1
- Comments:8 (5 by maintainers)
Top Results From Across the Web
How to Build the Best User Documentation (New Guide) | Blog
Have a product or service that needs user documentation? Here are some simple tips on how to build the best documentation for consumers....
Read more >Manual data update - User Guide - Google Sites
Double click on the source you wish to update. Then simply Follow the instructions according to the format of your data source. For...
Read more >10 Golden Rules to help you create a great user manual - Dokit
10 Golden Rules to help you create a great user manual · 10. Update the content · 9. Distribute your manuals · 8....
Read more >How to handle user guide updates vs release notes ... - Quora
Release new features together with guide updates. Make user guide updates part of the feature package and subject to the same experiments /...
Read more >How to Write A Manual That Your Users Will Love to Use
With this ultimate guide, I show you step-by-step how we create user-friendly, appealing and legally compliant user manuals for our clients in any...
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
Yes I installed Sphinx and i can build html, for the moment the syntax of sphinx is not so familiar to me fortunately I refer to the rst files of the Converse doc to better understand
I’ve now created a new ticket in the new repo: https://github.com/conversejs/user-manual/issues/1
Closing this one.