stacks-network / docs Goto Github PK

@hstove "hey, i was thinking, it might be nice to have some extra instructions for submitting your animal kingdom app to app.co. I think it'd be cool if they set the description to "Created by {name_or_twitter_handle}". That would give us at least some differentiation between a bunch of apps named "Animal Kingdom"

thomas [8 minutes ago]
imo we should push all apps to be https
but it's also different between browsers and such, it would be good to have a section on the docs talking about this specifically and the common issues people run into

• Local browser does not require https but the web browser does.

@larrysalibra commented on Thu Feb 15 2018

@larrysalibra commented on Wed Mar 07 2018

@shea256 you shared a paper doc with me a week or two with a draft of "what a blockstack app is" - how do you feel about publishing that and circulating it for comment?

users are confused about which phrases, keys, and values they share and which they should secure.

Supplants stacks-network/gaia#91 for tracking. Refer back for more info.

Currently, we are pointing users to the GAIA repo documentation. We want to expose that documentation to customers and to search.

URL: https://docs.blockstack.org/browser/storage-provider.html

This documentation will be linked from the browser upon completion of the OKR 5.4 epic: stacks-archive/blockstack-browser#1735.

@aulneau pointed out: Hey Mary! I'm reading up on the docs and I saw here -> https://docs.blockstack.org/core/naming/creationhowto.html that we're liking to live transactions, it would probs make sense to replace them with links to our explorer

moxiegirl [8:59 AM]
Yes. Let me make an issue so I don't forget

Refer to close duplicate here: stacks-network/gaia#143

Make sure the tutorials work in a Windows box.

Explain the major functions for the stacks wallet.

We should think about having a section on migrating from other blockchain platforms to Blockstack.
Cloud be similar to adding auth or migrating to that as the primary login, and eventually the same thing for Gaia.

@moxiegirl commented on Tue Sep 11 2018

@friedger suggested we build out a similar guide (simpler of course) https://developer.android.com/guide/

Currently, we have:

• tutorial (hello world)
• reference
• three more sophisticated but undocumented examples

@friedger commented on Fri Dec 14 2018

@moxiegirl I added some paragraphs in the README (See stacks-archive/blockstack-android#123) Should this stay there or go somewhere else? Should we generate documentation from the example codes? So that we can maintain the code only in the source folder?

@moxiegirl commented on Fri Dec 14 2018

@friedger Well, when it comes to API reference it makes sense to generate it from the source code. Tutorials are a bit problematic, depends on the tool of course. Do you have one in mind?

storage provider
storage hub

https://forum.blockstack.org/t/storage-terminology/6899/5

Refer to close issue here for further description: stacks-network/gaia#137

@vsund commented on Mon Feb 06 2017

Hey,

I'd really like to see some documentation about Blockstack's PKI and such things. I think it's pretty important to know because it's the core of trust which an user's identity has.

• Where does what trust come from?
• Where does keys get derived from?
• Is there one root key? / Are there device keys?
• How is the keychain constructed?

@muneeb-ali said that there's currently nothing out about that and I should write a request here.

@pstan26 commented on Mon Feb 06 2017

@vsund excellent idea, will add this to the documentation project list

@jackzampolin commented on Wed Jan 10 2018

Currently the only documentation we have on this is in this browser issue: stacks-archive/blockstack-browser#330

We should turn that issue into a more comprehensive document. Does this issue belong in this repo or the blockstack/blockstack-core repo?

@kantai @larrysalibra @jcnelson

@msc6272 commented on Mon Mar 05 2018

Dear fellows,

I am trying to understand Blockstack but I am unable to. I have so many doubts, and concerns, so I read the documentation and saw some videos in you homepage. But I am still unable to understand what it is. Please, give some information like: 101, for Dummies,... without jargon and as if it was intended for a 8 years old child. For example: I don't understand why should I move from one provider (e.g. Yahoo) to another provider (you). If I use your browser it seems like that. I registered in your website a few hours ago and I still don't know where is my private key stored in. Why do I need to use your browser? Why I should not choose another blockchain provider (I read the article about Ethereum, or whatever)? How it is independent, distributed, reliable, if I use the actual Internet infrastructure to support it? What if your infrastructure is under attack (miners, DNS, ...)? Why do you think users want the responsibility to keep their own data? A lot of questions I don't see any answer. Please, enlighten me.

@vsund commented on Sun Mar 18 2018

Hey @msc6272 I think this would be better suit the forum at https://forum.blockstack.org.
Happy to try my best with answering there :)

Closes stacks-network/gaia#160 in favor of this area per @friedger.

https://forum.blockstack.org/t/zero-to-dapp-tutorial-soft-launch/6791/6?u=moxiegirl

• Explain how to deploy
• Include examples on common sites
• Include CORS samples

stacks-network/stacks-core#504 (comment)

@muneeb-ali commented on Sat Sep 16 2017

We have some circular loops and broken old docs:

https://github.com/blockstack/blockstack-core/wiki/Protocol-Details
and
https://github.com/blockstack/blockstack/wiki/Blockchain-ID

We need to find a permanent home for protocol docs and commit to never changing that location again and maintain a revision history at that single place.

I propose using the "blockstack" repo and blockstack/docs directory with files like protocol.md and:

• not use wikis (they're complicated and hidden in the interface) and
• also not use the website; the website changes frequently and there is no revision history for it. The website can try to mirror the docs but it should not be the primary way to organize docs.

As our project grows it'll be extremely important to be able to refer to old versions of protocol specs.

@jackzampolin commented on Wed Jan 10 2018

Related: stacks-network/stacks#213

update the todo tutorial docs in regards to the referenced version of node. I couldn't get the yarn install to work otherwise.

stacks-archive/blockstack.org@9b24374#diff-4a1252ef0bffb7e1f6d46c2c737e449dR10

Per comments on the draft in Paper, I'd like to clarify the terminology we use in the Browser storage provider documentation aka "How you control your data" to ensure we're using terms like "storage provider" and "Gaia hub" in ways that are consistent with guidance provided on GitHub for Gaia and Gaia hubs in particular.

TOKEN_TRANSFER wire format

Need to write a windows-specific version of Zero to DApp

From Jeff's comments in the forums:

I really like the use case based approach to the sections. We know people dig around with the “evaluate” mindset, or the “get started” mindset. It makes me wonder what other obvious frames of reference there are. Also, what obvious non-use-case topics would be common that people just hunt for: Might be: “iOS” “Android” “Blockchain” “FAQ” I’m kind of expecting to see a list of those below this 6 big sections.

@GinaAbrams commented on Mon Dec 18 2017

@guylepage3 commented on Tue Dec 19 2017

Where would this live? I have an open issue on Blockstack.com

@GinaAbrams commented on Tue Dec 19 2017

@guylepage3 yeah that sounds good, so if people click token from blockstack.org it redirects and is live on blockstack.com

@GinaAbrams commented on Wed Jan 03 2018

drafted version (will send to Muneeb for review prior to moving forward)

@muneeb-ali commented on Sat Sep 16 2017

We have some circular loops and broken old docs:

https://github.com/blockstack/blockstack-core/wiki/Protocol-Details
and
https://github.com/blockstack/blockstack/wiki/Blockchain-ID

We need to find a permanent home for protocol docs and commit to never changing that location again and maintain a revision history at that single place.

I propose using the "blockstack" repo and blockstack/docs directory with files like protocol.md and:

• not use wikis (they're complicated and hidden in the interface) and
• also not use the website; the website changes frequently and there is no revision history for it. The website can try to mirror the docs but it should not be the primary way to organize docs.

As our project grows it'll be extremely important to be able to refer to old versions of protocol specs.

@jackzampolin commented on Wed Jan 10 2018

Related: stacks-network/stacks#213

@moxiegirl commented on Mon Jan 14 2019

Issue moved to blockstack/docs.blockstack #97 via ZenHub

You are not anonymous your address and its interactions are public. When you make an exchange your id becomes associated with your real-world transaction.

You cannot "undo" a transaction you make with coin.

Blockchain is not bitcoin.

@larrysalibra commented on Thu Feb 15 2018

• Architecture of a “Blockstack App” — @shea256 stacks-network/stacks#420
  • “What is a Blockstack App and how does it work?”
• High-level @muneeb-ali stacks-network/stacks#419
• Authentication — Lead: @larrysalibra, Document reviewer: @kantai hirosystems/stacks.js#370
• Profiles —Lead: @yknl , Document reviewer: @larrysalibra hirosystems/stacks.js#369
• Gaia Storage —Lead: @kantai , Document reviewer: @jcnelson @yknl stacks-network/gaia#90
• Managing Data with Gaia Introduction —Lead: @cwackerfuss, Document reviewer: @jcnelson @larrysalibra stacks-network/stacks#427
• Blockstack Naming Service — Lead: @jcnelson , Document reviewer: @kantai stacks-network/stacks-core#740
• Atlas — Lead: @jcnelson , Document reviewer: @muneeb-ali stacks-network/stacks-core#741
• Process — Lead: @larrysalibra Document reviewer: @cwackerfuss stacks-network/stacks#418

@larrysalibra commented on Wed Mar 07 2018

We've almost satisified this user story!

We still need:

• High-level docs #419 from @muneeb-ali (not sure where we are on this)
• Blockstack Apps docs #420 from @shea256 (a paper doc with a draft of this exists. Can we publish it for comment?)
• To clarify if @kantai has reviewed and signed off on @jcnelson 's naming service docs stacks-network/stacks-core#741
• To clarify if @muneeb-ali has reviewed and signed off on @jcnelson 's Atlas docs stacks-network/stacks-core#741
• Final review & sign off on @larrysalibra's auth docs by @kantai hirosystems/stacks.js#370
• Final review on process stacks-network/stacks#418

• What is the Stacks token and blockchain, and what are their advantages?
• How does it relate to Blockstack?
• What is Blockstack?
• How to purchase domain ID
• How to look up holdings

Currently, the Animal Kingdom is using a BETA version. We should call this out.

Additional Comment from Alex: I realize the tutorial is supposed to be beginner friendly but as a dev you start digging and it wasn’t super clear to me where the imports were coming from but more importantly how/why certain functions took certain argument types.

For some reason the docs builder didn’t pick up the TOKEN_TRANSFER wire format. It’s documented here: https://github.com/blockstack/blockstack-core/blob/master/docs/wire-format.md#token_transfer 3

Zero-to-Dapp and other tutorials where we have browser limitations with login via the Web edition, we should note this.

It seems as though we simply hide the section navigation on mobile, which makes it hard or impossible for mobile visitors to find certain sections unless they're linked from inside the content.

Can we add this navigation to mobile as well?

Original stacks-archive/app.co#38

User/investor suggestion

makeAuthRequest now includes a new parameter for indicating whether not the onboarding flow is going to include storage provider flow.

hirosystems/stacks.js#569

This information will be covered in the blog going out with the release.

Need to expand the tutorial for Authentication to provide guidance around this new workflow.

cc: @hstove @markmhx

• Document changes to the onboarding with this new option
• Add developer-optional Gaia hub choice during onboarding (#stacks-archive/blockstack-browser#1723)

From: stacks-archive/blockstack-browser#1776

The way the state update logic works is that it updates the profile.json for all local identities you have in the browser. This should be sufficient, because the only effected profile.json's are the ones you've logged into with in your browser.

It iterates and updates all profile.json's before even updating state.

When updating the profile.json, it creates a new Gaia token before signing, so any effected Gaia tokens in the profile.json will not be used. This means they can be invalidated before doing the state update, and the write will still work.

In https://docs.blockstack.org/org/faq.html
the two links should be swapped:

Whitepapers
Blockstack Token Whitepaper
Blockstack Token Sale Mechanics

@larrysalibra commented on Thu Feb 15 2018

@larrysalibra commented on Wed Mar 07 2018

@muneeb-ali where are we on this issue?

issue

Add reference for Android SDK, iOS SDK, react-native SDK(?) next to Javascript reference https://docs.blockstack.org/common/javascript_ref.html

See #882 PR for basic information and conversation.
See hirosystems/stacks.js#559
Closes stacks-network/stacks-core#883
stacks-archive/blockstack-browser#1679