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

Study: Writerside for documentation? #927

Open
julien-deramond opened this issue May 6, 2024 · 0 comments
Open

Study: Writerside for documentation? #927

julien-deramond opened this issue May 6, 2024 · 0 comments
Labels
📖 documentation Improvements or additions to documentation 🔍 study

Comments

@julien-deramond
Copy link
Member

Description

The aim of this study is to check if using Writerside could be a better alternative to our current documentation system based on Jekyll + Orange theme.

The current documentation is really basic and needs a lot of actions from the web team, especially regarding the theming approach, the menu, etc.

Writerside seems to be more Android-developer friendly in terms of DX for the library users, and maybe in terms of maintenance for the core team.

  • What do you think of this tool?
  • Would it be better to switch to it?
  • Are there any blocking points? Technical, in terms of features, licensing, etc.
  • etc.
@julien-deramond julien-deramond added 📖 documentation Improvements or additions to documentation 🔍 study labels May 6, 2024
@julien-deramond julien-deramond changed the title Study: Writerside Study: Writerside for documentation? May 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📖 documentation Improvements or additions to documentation 🔍 study
Projects
None yet
Development

No branches or pull requests

1 participant