search

jacob-macleod / Dolphin-Flashcard-App

http://www.dolphinflashcards.com
MIT License
1 stars 3 forks source link

Convert Documentation to Mintlify #125

Open jacob-macleod opened 1 month ago

jacob-macleod commented 1 month ago

Convert the existing documentation to mintlify, which will make the docs a lot nicer to read and understand. Below are some links: https://mintlify.com/docs/quickstart#creating-your-documentation-repository https://github.com/mintlify/starter https://github.com/mintlify/starter/blob/main/mint.json

The initial setup can be based on https://github.com/mintlify/starter, but make sure you change the folder structure, possibly putting all files inside docs/ to make the repo simpler.

Setup the code to upload a static site to mintlify.

Give the documentation a blue theme, to fit in with dolphin flashcards

kenudeh commented 1 month ago

I'll take this up, Jacob.

kenudeh commented 1 month ago

I'll take this up, Jacob.

jacob-macleod commented 1 month ago

Great, thanks!

jacob-macleod commented 1 week ago

Also @kenudeh I've just merged a big branch to switch databases. I've deprecated some API methods by commenting them out, which you can see in CHANGELOG.md

jacob-macleod commented 1 week ago

@kenudeh the new unit tests also give information on how the API routes work, and how they deal with edge cases such as when data does not exist