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

Create formal documentation #144

Open
rnowling-memphis opened this issue Apr 28, 2023 · 3 comments
Open

Create formal documentation #144

rnowling-memphis opened this issue Apr 28, 2023 · 3 comments
Labels
good first issue Good for newcomers

Comments

@rnowling-memphis
Copy link
Contributor

rnowling-memphis commented Apr 28, 2023

The README.md file contains examples for using the Python SDK. The SDK would really benefit from more formal documentation (e.g., generated with Sphinx) that includes both narrative (e.g., a tutorial, recipes for common tasks) and API documentation. The documentation could be hosted on Read the Docs.

@idanasulin2706 idanasulin2706 added the good first issue Good for newcomers label Apr 30, 2023
@idanasulin2706
Copy link
Contributor

I love that, I tagged it as good first issue, let's see if someone from the community will take it

@RaviTeja51
Copy link

Hi, I would like to take this up, however, I am new to open-source contributions and I feel it is good to have a functional understanding before taking up the documentation. Would anyone please suggest a better way to understand the SDK implementation

@idanasulin2706
Copy link
Contributor

@RaviTeja51 I think that the best start is to install Memphis locally, and start playing around with the SDK. After you will be a user of that SDK you will be at a better point than you are currently.

Installing Memphis locally

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants