scope3data / methodology

Measurement methodology for advertising emissions
https://methodology.scope3.com
Apache License 2.0
32 stars 11 forks source link

feat: add mintlify to docs to make it easier to read #127

Closed MikeFreyberger closed 1 year ago

MikeFreyberger commented 1 year ago

https://mintlify.com/ makes it really easy to turn markdown files inside of a github repo and turn it into a easily navigable/searchable website.

All that was needed it adding a mint.json file and changing the docs from .md files to .mdx files. The downside to this is that when navigating github, the docs file are not automatically formatted because github doesn't recognize the mdx file.

The upside is that this is much easier to navigate and read for anyone not comfortable with github.

Screenshot 2023-07-10 at 9 29 17 PM

Once these merges, we will set up hosting the published version of the docs at methodology.scope3.com (as explained in docs/readme.md). For now, here's the content hosted on a mintlify domain: https://scope3.mintlify.app/lifecycle