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

[IDEA] Documentation tool and style #72

Open
gialmisi opened this issue Dec 4, 2023 · 0 comments
Open

[IDEA] Documentation tool and style #72

gialmisi opened this issue Dec 4, 2023 · 0 comments
Labels
restructuring Label for the DESDEO restructuring project

Comments

@gialmisi
Copy link
Contributor

gialmisi commented Dec 4, 2023

  • What is the current behavior?
    We are currently utilizing sphinx for documentation. Each sub-project in DESDEO has currently its own implementation of sphinx-based documentation. Each one of these needs to be always manually modified. Moreover, our documentation style should be more clearly structured.

  • Describe the solution you'd like
    We should move to a simpler tool and adopt a clear (and tested) documentation structure. We have previously already discussed MkDocs, which is a promising candidate for an alternative tool.
    As for the structure of the documentation, we should follow the diataxis philosophy.

  • What is the motivation/use case for changing the behavior?
    Sphinx is complicated. With a simpler tool, the bar to write and contribute to the documentation will be lowered. With a clear structure for the documentation, we, and users, have also a clearer picture of where to find relevant content. Diataxis is followed by other projects as well, it is tried and tested, and will meet the expectations of many users when it comes to documentation.

  • Describe alternatives you've considered
    Sphinx has been the only real alternative we have considered and used. It works, but the features it offers at the cost of added complexity are not justified for our use-case.

  • Additional context
    This is related to the structure of the project. With a monolithic structure (discussed in [IDEA] New project structure for DESDEO #73 ), we will also end up with a single documentation to work on, which facilitates things a lot.

@gialmisi gialmisi added the restructuring Label for the DESDEO restructuring project label Dec 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
restructuring Label for the DESDEO restructuring project
Projects
None yet
Development

No branches or pull requests

1 participant