Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
🔧 Problem
We need a place to write, maintain and serve technical documentation for the project. Gitbook is for methodology docs and doesn't support bi-directional git syncing, and Notion leaves a lot to be desired in terms of UX and browseability.
🍰 Solution
Use mdbook, a tool allowing to generate HTML docs out of Markdown files, the text file format we already know and use for other docs and which can be exported from Notion.
🏝️ How to test
Browse the generated HTML docs at https://ecobalyse-pr720.osc-fr1.scalingo.io/tech-docs