ovos-docs-viewer

A terminal application that shows OpenVoiceOS documentation. It downloads the docs from GitHub and displays them in a text-based browser. A file tree sits on the left, and a markdown viewer sits on the right.

Installation

pip install ovos-docs-viewer

Usage

$ ovos-docs-viewer --help
Usage: ovos-docs-viewer [OPTIONS] DOCS

  View documentation for: skills | live-status | raspOVOS | installer |
  technical | messages | hivemind

Options:
  --help  Show this message and exit.

Pick a documentation set from the list above. The tool downloads the matching docs on first use and caches them locally. Use the file tree to pick a page, and read it in the markdown viewer.

Related projects

• OpenVoiceOS/ovos-technical-manual: the technical manual shown by the technical doc set.
• OpenVoiceOS/ovos-installer: the installer shown by the installer doc set.
• OpenVoiceOS/message_spec: the bus message spec shown by the messages doc set.
• OpenVoiceOS/status: the status page shown by the live-status doc set.
• TigreGotico/raspOVOS: the raspOVOS docs shown by the raspOVOS doc set.
• JarbasHiveMind/HiveMind-community-docs: the HiveMind docs shown by the hivemind doc set.

License

See the LICENSE file.