Skip to content

Update the user manual #1

@jcbrand

Description

@jcbrand

Original ticket here: conversejs/converse.js#1383

The 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

Expanding the manual with more information (WIP)

  • OMEMO Encryption
  • OMEMO Encryption in a groupchat
  • How to verify OMEMO fingerprints

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions