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 docs #130

Open
12 tasks
sverhoeven opened this issue Mar 20, 2023 · 0 comments
Open
12 tasks

Improve docs #130

sverhoeven opened this issue Mar 20, 2023 · 0 comments

Comments

@sverhoeven
Copy link
Member

sverhoeven commented Mar 20, 2023 •
edited
Loading

  • README.md
    • Add introduction from docs/introduction.rst to README.md as currently intro is a bit short.
    • Move client site to top of usage as most users will use client
    • Link TLDR code snippets to doc website for more info.
  • Add code of conduct
  • Add contributing docs
  • docs/
  • docstrings
    • create_grpc_channel + get_unique_port in BmiClient
    • get_value_ref in BmiClientApptainer
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
@sverhoeven