search

alexprengere / currencyconverter

A Python currency converter using the European Central Bank data.
http://alexprengere.github.io/currencyconverter
Apache License 2.0
215 stars 59 forks source link

Add link to reference docs in README #25

Closed Leo-Ryu closed 3 years ago

Leo-Ryu commented 3 years ago

Would it be helpful if I migrated over parts of the README to a userguide document in the docs?

Leo-Ryu commented 3 years ago

@alexprengere Besides the reference docs, is there anything at all you'd like to have in the docs? I'll tailor them to your needs

alexprengere commented 3 years ago

The rendered README seems to not interpret rst directives (code-block mostly). If there is a way to fix this, then this should be the default url the link points to. Then I believe this is good enough to be merged. For now reference docs and the README are a good starting point.

Leo-Ryu commented 3 years ago

@alexprengere README now rendered and https://docs.contour.so/alexprengere/currencyconverter/README is the default link to documentation-- let me know if there's anything else!

TimothyWang56 commented 3 years ago

@alexprengere Hi there, and happy holidays! I'm Tim, a student at Brown University, working on this documentation platform with @Leo-Ryu. We're really interested in improving the platform and building it out based on user-feedback, and would appreciate any feedback you might have after having it merged in for a little over a week. Feel free to reach out with any thoughts/critiques!