lostisland / faraday_middleware

Various Faraday middlewares for Faraday-based API wrappers
MIT License
556 stars 205 forks source link

Turn wiki into docs/ of Markdown #250

Closed olleolleolle closed 4 years ago

olleolleolle commented 4 years ago

This Issue is about turning the wiki into git-controlled Markdown files.

it’s easier to maintain and keep in track with the code. It also allow you to jump into a sort of “time machine” by checking out any past tag and seeing how the doc was at that point in time, which I find really useful

Also, updates to the documentation can be part of the same PR where new features are introduced or the API is changed

This is how Faraday has it: https://github.com/lostisland/faraday/tree/master/docs

In order to start

olleolleolle commented 4 years ago
image

This is the setting we now use.

olleolleolle commented 4 years ago

Added the note about Markdown documents in repo to the sidebar in the wiki:

image