Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

TODO: update the documentation #267

Closed
AsakusaRinne opened this issue Nov 8, 2023 · 4 comments
Closed

TODO: update the documentation #267

AsakusaRinne opened this issue Nov 8, 2023 · 4 comments
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@AsakusaRinne
Copy link
Collaborator

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.

@AsakusaRinne AsakusaRinne added the documentation Improvements or additions to documentation label Nov 8, 2023
@AsakusaRinne AsakusaRinne self-assigned this Nov 8, 2023
@martindevans martindevans self-assigned this Nov 8, 2023
@AsakusaRinne AsakusaRinne moved this to 📋 TODO in LLamaSharp Dev Nov 9, 2023
@AsakusaRinne AsakusaRinne mentioned this issue Nov 13, 2023
8 tasks
@martindevans martindevans added the help wanted Extra attention is needed label Jan 7, 2024
@vikramvee
Copy link
Contributor

@AsakusaRinne can I help here?

@martindevans
Copy link
Member

@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. Docs broken  #467)
  • General update of getting started (copy versions table from readme, remove old models, add some new ones etc).

@vikramvee
Copy link
Contributor

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

@AsakusaRinne AsakusaRinne added the good first issue Good for newcomers label Mar 7, 2024
@AsakusaRinne AsakusaRinne moved this from 📋 TODO to ✅ Done in LLamaSharp Dev Apr 21, 2024
@AsakusaRinne
Copy link
Collaborator Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
Status: ✅ Done
Development

No branches or pull requests

3 participants