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.

Sign up for GitHub

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

Jump to bottom

docs and fixes #24

Merged
merged 1 commit into from
Sep 11, 2019
Merged

docs and fixes #24

merged 1 commit into from
Sep 11, 2019

Conversation

jmank88
Copy link
Contributor

@jmank88 jmank88 commented Sep 4, 2019 •
edited
Loading

Towards #23

@jmank88 jmank88 requested a review from treeder September 4, 2019 20:01
@jmank88 jmank88 marked this pull request as ready for review September 6, 2019 10:57
r-gochain
r-gochain reviewed Sep 6, 2019
View reviewed changes
README.md Outdated Show resolved Hide resolved
treeder
treeder requested changes Sep 6, 2019
View reviewed changes
Copy link
Contributor

@treeder treeder left a comment

Choose a reason for hiding this comment

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

I don't see anything about how the user is supposed to pay for their files. That's literally the most important thing. Adding a file without paying for it is pointless.

@jmank88
Copy link
Contributor Author

jmank88 commented Sep 6, 2019

I don't see anything about how the user is supposed to pay for their files. That's literally the most important thing. Adding a file without paying for it is pointless.

I'll improve the docs on the pin interface method and the gofs pin command. There is an example usage of paying with gofs pin. Did you have something else in mind for the format of these docs? I don't have a clear picture of where these should end and defer to https://gofs-help.gochain.io/ , so I've just started with technical docs on what is here, thinking it would be for more savvy users.

treeder
treeder requested changes Sep 6, 2019
View reviewed changes
cmd/gofs/README.md Outdated Show resolved Hide resolved
cmd/gofs/README.md Show resolved Hide resolved
cmd/gofs/README.md Outdated Show resolved Hide resolved
cmd/gofs/README.md

COMMANDS:
pin Pin a CID
wallet Get the deposit wallet for the CID.
Copy link
Contributor

Choose a reason for hiding this comment

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

What is a wallet? Either explain here or link to docs that explain it.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Where is the appropriate place to document that? This repo? Or the help site?

Copy link
Contributor

Choose a reason for hiding this comment

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

Help site probably best.

@treeder
Copy link
Contributor

treeder commented Sep 6, 2019

I don't see anything about how the user is supposed to pay for their files. That's literally the most important thing. Adding a file without paying for it is pointless.

I'll improve the docs on the pin interface method and the gofs pin command. There is an example usage of paying with gofs pin. Did you have something else in mind for the format of these docs? I don't have a clear picture of where these should end and defer to https://gofs-help.gochain.io/ , so I've just started with technical docs on what is here, thinking it would be for more savvy users.

Everywhere that requires a payment should explain how to pay for it, or link to somewhere that explains it.

@treeder treeder assigned treeder and unassigned treeder Sep 10, 2019
@treeder treeder merged commit 8938124 into master Sep 11, 2019
@treeder treeder deleted the docs branch September 11, 2019 21:26
@jmank88 jmank88 mentioned this pull request Sep 12, 2019
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@treeder treeder treeder requested changes

@r-gochain r-gochain r-gochain approved these changes

@brockmcblockchain brockmcblockchain Awaiting requested review from brockmcblockchain

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@jmank88 @treeder @r-gochain