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.

Sign up for GitHub

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

Jump to bottom

Improve documentation #50

Open
3 tasks
ZedongPeng opened this issue Aug 18, 2024 · 0 comments
Open
3 tasks

Improve documentation #50

ZedongPeng opened this issue Aug 18, 2024 · 0 comments

Comments

@ZedongPeng
Copy link
Member

Documentation Improvements

I’ve identified some areas where the documentation can be enhanced for clarity and completeness:

  • Update the model size table (see issue Update problem size table #45).
  • Add usage examples, especially for handling problems with multiple cases.
  • Include a comprehensive list of problems (models) in readme.md. And considering adding links to improve navigation.

If you have any additional suggestions for improving the documentation, feel free to share them!
@bernalde @tristantc @AlbertLee125
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@ZedongPeng