Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Find tools to replace the docs client #160

Closed
HerrTopi opened this issue Nov 18, 2020 · 4 comments
Closed

Find tools to replace the docs client #160

HerrTopi opened this issue Nov 18, 2020 · 4 comments
Assignees
Labels
1 1 story point Research

Comments

@HerrTopi
Copy link
Contributor

Context

Docs client

Summary

We need to pick a tool capable of handling versioning and all currently implemented features of the docs.

Justification

We'd like to support multiple versions of the project in the docs app.

Additional Details

Check out readthedocs.io , nextjs-MDX, Storybook, (most likely we want to use markdown)

@HerrTopi HerrTopi added Research 1 1 story point labels Nov 18, 2020
@matyasf matyasf self-assigned this Nov 20, 2020
@matyasf
Copy link
Collaborator

matyasf commented Nov 23, 2020

I could not find any out-of-the-box solution for this issue. The closest one is ReadTheDocs:
+ support versions
+ renders .md files
- no live code out of the box (I could not find any examples, likely doable with a Sphinx plugin)
- no RTL support, see readthedocs/readthedocs.org#2463
- based on Python, we might need to write plugins in Python
~ Accessibility needs testing
+ sphinx-js can partially autogenerate documentation

@matyasf
Copy link
Collaborator

matyasf commented Nov 23, 2020

Another contender is Docusaurus V2
+ Written in React, is really easy to use React components
+ maintained by Facebook
+ supports versions
- could not find a way to autogenerate docs from code, we might need to write a plugin for this.
~ V2 is in alpha (but is already used in lots of places in production)

@matyasf
Copy link
Collaborator

matyasf commented Nov 25, 2020

Open questions:

  • Can we reuse our docs from code autogenerator (ui-docs-plugin) in Docusaurus?
  • How hard is it to introduce versions to the current tool?

@matyasf
Copy link
Collaborator

matyasf commented Nov 25, 2020

The current ui-docs-client would need the following fixes:

  • versioning
  • emotion migration
  • it has many roots in the DOM, this might be a issue
  • fix performance issues

We decided to keep the current solution and do the aforementioned fixes.

@matyasf matyasf closed this as completed Nov 25, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1 1 story point Research
Projects
None yet
Development

No branches or pull requests

2 participants