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

Documentation Request: Document the existing codebase using ReadTheDocs and Sphinx #30

Closed
notadamking opened this issue Oct 12, 2019 · 11 comments
Labels
$$$$ 2+ $ETH in Funding documentation Improvements or additions to documentation funded This issue is funded via Gitcoin. good first issue Good for newcomers help wanted Extra attention is needed

Comments

@notadamking
Copy link
Collaborator

notadamking commented Oct 12, 2019

Funding amount:
2 ETH (~$400)

Description:
Document each component described in the article, as well as each existing feature in the codebase (Each file in the /tensortrade directory).

  • Write a complete description of each component and file in the /tensortrade directory.
  • Include example usage of each use case and its possible solutions.
  • Briefly define and explain any variables or parameters.
  • Documentation must be publishable via Readthedocs.org using the Sphinx framework.
  • Documentation should be brief, yet complete. It should be simple and easy to read.

Use the TensorTrade tutorial article as a reference for describing components and defining their usage.

@notadamking notadamking added documentation Improvements or additions to documentation help wanted Extra attention is needed good first issue Good for newcomers funded This issue is funded via Gitcoin. labels Oct 12, 2019
@gitcoinbot
Copy link

Issue Status: 1. Open 2. Started 3. Submitted 4. Done


This issue now has a funding of 0.5 ETH (90.37 USD @ $180.73/ETH) attached to it as part of the tensortrade-org fund.

@gitcoinbot
Copy link

Issue Status: 1. Open 2. Started 3. Submitted 4. Done


Work has been started.

These users each claimed they can complete the work by 1 month from now.
Please review their action plans below:

1) ult-processor has started work.

i will go through the materials
i will start a project so that i can be using it to learn and write about the system.
i will use and write about the features with an example of how i used it.
i will submit every 2 days the documentation updating it 48 hrs interval.
i will report i have completed it .

Learn more on the Gitcoin Issue Details page.

1 similar comment
@gitcoinbot
Copy link

Issue Status: 1. Open 2. Started 3. Submitted 4. Done


Work has been started.

These users each claimed they can complete the work by 1 month from now.
Please review their action plans below:

1) ult-processor has started work.

i will go through the materials
i will start a project so that i can be using it to learn and write about the system.
i will use and write about the features with an example of how i used it.
i will submit every 2 days the documentation updating it 48 hrs interval.
i will report i have completed it .

Learn more on the Gitcoin Issue Details page.

@gitcoinbot
Copy link

gitcoinbot commented Oct 12, 2019

Issue Status: 1. Open 2. Started 3. Submitted 4. Done


Work has been started.

These users each claimed they can complete the work by 6 days, 6 hours from now.
Please review their action plans below:

1) ult-processor has started work.

i will go through the materials
i will start a project so that i can be using it to learn and write about the system.
i will use and write about the features with an example of how i used it.
i will submit every 2 days the documentation updating it 48 hrs interval.
i will report i have completed it .
2) ult-processor has started work.

i will go through the materials
i will start a project so that i can be using it to learn and write about the system.
i will use and write about the features with an example of how i used it.
i will submit every 2 days the documentation updating it 48 hrs interval.
i will report i have completed it .
3) ult-processor has started work.

i will go through the materials
i will start a project so that i can be using it to learn and write about the system.
i will use and write about the features with an example of how i used it.
i will submit every 2 days the documentation updating it 48 hrs interval.
i will report i have completed it .
4) micaebe has started work.

  1. Describtion of each component, file, variable and parameter

  2. Example usage
    5) funlyonions has started work.

  3. Start with multi-line comments on each function inside of the RL library.

  4. Highlight how each part interacts with each other. Do an in-paper diagram, then create a diagram using the LibreOffice Draw program.

  5. Start writing the markdown and briefly describe how each part of the code base works.

  6. Compile the readthedocs code base and send off instructions for review.

Learn more on the Gitcoin Issue Details page.

@notadamking notadamking changed the title Request: Document the existing codebase using ReadTheDocs and Sphinx Documentation Request: Document the existing codebase using ReadTheDocs and Sphinx Oct 12, 2019
@notadamking notadamking added the $$ 0.5+ $ETH in Funding label Oct 20, 2019
@gitcoinbot
Copy link

Issue Status: 1. Open 2. Started 3. Submitted 4. Done


The funding of this issue was increased to 1.0 ETH (176.67 USD @ $176.67/ETH) .

@notadamking notadamking added $$$ 1+ $ETH in Funding and removed $$ 0.5+ $ETH in Funding labels Oct 21, 2019
@notadamking
Copy link
Collaborator Author

I have doubled the funding on this issue.

@gitcoinbot
Copy link

Issue Status: 1. Open 2. Started 3. Submitted 4. Done


The funding of this issue was increased to 2.0 ETH (382.08 USD @ $191.04/ETH) .

@gitcoinbot
Copy link

gitcoinbot commented Nov 3, 2019

Issue Status: 1. Open 2. Started 3. Submitted 4. Done


Work for 2.0 ETH (379.67 USD @ $189.83/ETH) has been submitted by:

  1. @antonyip
  2. @funlyonions

@notadamking please take a look at the submitted work:


@notadamking notadamking added $$$$ 2+ $ETH in Funding and removed $$$ 1+ $ETH in Funding labels Nov 5, 2019
@notadamking
Copy link
Collaborator Author

Closed by #88

@gitcoinbot
Copy link

Do More Faster ⚡️ A *Do More Faster* Kudos has been sent to @funlyonions for this issue from @notadamking. ⚡️

Nice work @funlyonions!
To redeem your Kudos, login to Gitcoin at https://gitcoin.co/explorer and select 'Claim Kudos' from dropdown menu in the top right, or check your email for a link to the Kudos redemption page.

@gitcoinbot
Copy link

Issue Status: 1. Open 2. Started 3. Submitted 4. Done


The funding of 2.0 ETH (377.18 USD @ $188.59/ETH) attached to this issue has been approved & issued to @funlyonions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
$$$$ 2+ $ETH in Funding documentation Improvements or additions to documentation funded This issue is funded via Gitcoin. good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants