server icon indicating copy to clipboard operation
server copied to clipboard

Research: end-user platform documentation

Open SimoneZaza opened this issue 1 year ago • 0 comments

Description

As a user I want to be able to browse/search through Alkemio's user documentation inside the platform in a smooth way.

Acceptance criteria

  • [ ] A list of +/- for each of the alternatives, taking in at least the following criteria:
  • Supports multiple languages ((semi-)automatic translations of course would be amazing, but not necessary), maybe we could have a crowdin integration?)
  • Easy for the user to navigate, search, understand where they are, with a clear tree view on the left
  • Browsable(?) for our chat engine
  • Easy for the Product team to manage the content
  • Easy to implement visuals in the content

Options to explore:

  • Docusaurus: https://docusaurus.io/docs
  • Mintlify: https://mintlify.com/
  • Gitbook (open source?): https://www.gitbook.com/ - https://github.com/GitbookIO
  • Bookstack: https://www.bookstackapp.com/

Additional Context

Rough sketch of the UI of the ideal integration:

Image

SimoneZaza avatar Feb 19 '24 13:02 SimoneZaza