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

Add docs directory #56

Merged
merged 20 commits into from
Feb 16, 2021
Merged

Add docs directory #56

merged 20 commits into from
Feb 16, 2021

Conversation

psiemens
Copy link
Contributor

@psiemens psiemens commented Feb 15, 2021

Description

This PR adds a /docs directory that can be imported by the Flow documentation website.

Check out the live build: https://docs.onflow.org/flow-cli/


For contributor use:

  • Targeted PR against master branch
  • Linked to Github issue with discussion and accepted design OR link to spec that describes this work
  • Code follows the standards mentioned here
  • Updated relevant documentation
  • Re-reviewed Files changed in the Github PR explorer
  • Added appropriate labels

@psiemens psiemens added the Documentation The issue in documentation, missing docs, invalid docs, outdated docs label Feb 15, 2021
@psiemens psiemens requested a review from devbugging February 15, 2021 04:40
Copy link
Contributor

@devbugging devbugging left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think docs look great. More commands should be documented in the future and the home page should have general info, maybe a command structure tree etc...
One comment is that maybe flow accounts create could have a precondition that you have to run flow init since if you just come to that page in readme not knowing other things someone might be confused why is not working but that is minor.

Copy link
Contributor

@janezpodhostnik janezpodhostnik left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! This will be very useful.


Indicate whether to wait for the transaction to be sealed.
If true, the CLI will block until the transaction has been sealed or
a timeout is reached.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be great to mention what the timeout is here I think

@psiemens psiemens merged commit c478df6 into master Feb 16, 2021
@psiemens psiemens deleted the docs branch February 16, 2021 06:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation The issue in documentation, missing docs, invalid docs, outdated docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants