SciSharp/LLamaSharp

TODO: update the documentation

AsakusaRinne opened this issue · 4 comments

AsakusaRinne commented

The documentation has been outdated after v0.5.1. I'll update it after the next release. And I'll appreciate for any help about it.

vikramvee commented

@AsakusaRinne can I help here?

  • ❤️1
martindevans commented

@vikramvee help with the documentation would be very much appreciated!

A few ideas for things that could be done:

  • Add a new version (at the moment there are versioned docs for 0.4 and 0.5)
  • Regenerate automatically generated docs
  • Check that scripts in Examples all work, update broken ones
  • Add new examples based on the examples in the code.
  • Check for broken links (e.g. #467)
  • General update of getting started (copy versions table from readme, remove old models, add some new ones etc).
vikramvee commented

I am on that, will understand the project. And Keep updating you with the progress.

  • 👍1
AsakusaRinne commented

The docs have been updated since v0.11.1. If you have any idea about how to improve it, please feel free to comment here or open a new issue. Thank you! @vikramvee

  • 👍1