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

Updates to Documentation(Reference, Markdown and Rust docs) #92

Open
irfanghat opened this issue Aug 15, 2024 · 0 comments
Open

Updates to Documentation(Reference, Markdown and Rust docs) #92

irfanghat opened this issue Aug 15, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@irfanghat
Copy link
Owner

Updates to Documentation (Reference, Markdown, and Rust Docs)

We're looking for contributors to help improve the documentation for render_cdk, a crate that provides a streamlined interface for interacting with Render, a platform for building, deploying, and scaling apps effortlessly.

render_cdk abstracts Render's API, making it easier to work with Render Cloud programmatically. However, to ensure developers can fully leverage the crate's potential, we're seeking help in improving the following areas of documentation:

  • Reference Docs: Clarify usage examples, method explanations, and API details.
  • Markdown Docs: Improve and expand our guides and README files.
  • Rust Docs: Ensure proper inline documentation of all public methods and structs, following Rust's doc conventions.

If you're passionate about open source, Rust, and cloud infrastructure, this is a great opportunity to contribute!

@irfanghat irfanghat added documentation Improvements or additions to documentation help wanted Extra attention is needed good first issue Good for newcomers labels Aug 15, 2024
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
None yet
Development

No branches or pull requests

1 participant