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

Contract deployment documentation #50

Closed
psiemens opened this issue Feb 4, 2021 · 0 comments · Fixed by #57
Closed

Contract deployment documentation #50

psiemens opened this issue Feb 4, 2021 · 0 comments · Fixed by #57
Assignees
Labels
Documentation The issue in documentation, missing docs, invalid docs, outdated docs

Comments

@psiemens
Copy link
Contributor

psiemens commented Feb 4, 2021

We need to ensure that the new functionality introduced in #45 is well documented.

I think it probably makes sense to add documentation in these places:

  • The code itself should be documented by following godoc standards
  • The command should be well-documented on the CLI help page (e.g. flow projects deploy --help)
  • The documentation site should be updated to include examples and usage instructions
@psiemens psiemens added the Documentation The issue in documentation, missing docs, invalid docs, outdated docs label Feb 4, 2021
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 a pull request may close this issue.

2 participants