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

feat: add local technical docs. #720

Closed
wants to merge 8 commits into from
Closed

feat: add local technical docs. #720

wants to merge 8 commits into from

Conversation

n1k0
Copy link
Member

@n1k0 n1k0 commented Sep 3, 2024

🔧 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

@n1k0 n1k0 force-pushed the technical-docs branch 4 times, most recently from 583d696 to d158213 Compare September 3, 2024 15:12
README.md Outdated Show resolved Hide resolved
tech-docs/src/gestion-des-tests.md Outdated Show resolved Hide resolved
@n1k0
Copy link
Member Author

n1k0 commented Sep 16, 2024

I prefer closing this as this isn't high priority and exposes a lot more challenges hosting-wise than initially envisioned. And we don't have much technical stuff to write more that what already exists.

@n1k0 n1k0 closed this Sep 16, 2024
@n1k0 n1k0 deleted the technical-docs branch September 16, 2024 14:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants