textileio / community Goto Github PK

Where are decisions made about encryption and where does encrypted data come into play. Should probably touch on Threads, Schemas and Files. Also sync, wallets, and devices.

Renaming this one to... just "write all the docs"

I've configured these docs to just pull docs from each of the project libraries,

https://github.com/textileio/docs/blob/master/Makefile#L7

Right now it takes the root README.md. Here, I'd like to standardize all repos to split repo overview README.md in the root and a docs readme in docs/README.md. Optionally, repos could add other files under docs/ but as long as that main one is there. We can then format these similarly so that when unified in this repo they all look the same.

I am not sure if there are updates needed here in the tour (https://docs.textile.io/a-tour-of-textile/) w/ the new command-line tool. Seems likely.

Children:

• textileio/go-textile#783
• textileio/go-textile#793
  • handled by textileio/go-textile#762
• textileio/go-textile#794
• textileio/go-textile#795
• textileio/go-textile#797
  • textileio/go-textile#799
• textileio/go-textile#809
• revises docs for textileio/go-textile#812

Scenario:

A user is part of a project/app with many threads.

How can that user publish a public feed of their contributions across all threads?

https://docs.textile.io/concepts/cafes/

https://docs.textile.io/develop/clients/command-line

We'll need to figure out how to make the nice table of contents for each command (and sub-commands indented) now that the tool doesn't spit out markdown.

Hey All, thanks for the awesome documentation. It's super helpful and you've done a great job at making it easy to get started. As I'm going through it, I ran across a few things I thought I should share:

• When adding locations on windows via CLI, I had to remove the single quotes. Just need to note the issue for Windows.
• When doing the section about sending and accepting invites I ran into a problem finding my buddy peer. I triple checked the Acct Id, and it was all correct. Eventually, after waiting a while and trying again, it found the peer. It might be worth mentioning that they should wait a bit after firing up the buddy node to ensure that it's connected to the network.
• It talks about ignoring the invite and gives the code to do that, but it doesn't provide the code needed to accept the invite, just the success message. (it's textile invites accept "QmWcd5RoyFBsA65EKiJRNsmhoDLADTgRXdri469Fj9nndN" --api="http://127.0.0.1:41600")
• When creating the Cafe Token you need to include --api="http://127.0.0.1:41600" or ensure you're working from the terminal with that env variable set. It might be best to just include the flag in the code example.

I'll take a stab at fixing these if you agree on the proposed changes.

The use of plaintext should be more thoroughly explained for cases where threads or apps could benefit from pinning unencrypted data in threads

This is a regression from switching to HTML based docs for the command line client.

noticed that in the JS examples it is undefined, which we should discourage as it could save devs future migration annoyances to be using it already.

This doc is being used quite a bit elsewhere to help on-board potential new contributors: https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github

https://docs.textile.io/policies/privacy-policy/

We should just add our .circleci configs to docs in some way

This blog post has out of date syntax. probably quickest win will be to point to the examples/how-to section of docs when they are ready by throwing an Update notice up top when ready,

• https://medium.com/textileio/quick-look-textile-files-and-schemas-36e9d131f229
• https://medium.com/textileio/easy-integrations-with-textile-thread-streams-7f1e3ce5c9b4

It has some helpful organizational tools for subscribing to updates, but it's not super clear from the API docs alone how to use them. Feels like Feed itself should get a concept page to talk about why a developer would use it and some of the different options.

Critical

Needs a section for schemas and a section for mills.

Needs a section for blocks.

We should go through and document just what happens during different type of removals in Textile.

• Remove a private thread
• Remove a shared thread
• Remove a file
• Remove a contact

The current one is hitting a very old deprecated cafe.

e.g. it takes a lot of looking to realize that there is a horizontal scroll here

• Pull in and reformat latest RN Docs
• Add CI script to publish

Couldn't find info on source, checksum is self explanatory but could still use a line in here, etc.

The command line API has changed. This needs to be updated in the tour to match version 0.5.0 at least.

Ones such as, https://medium.com/textileio/easy-personal-ipfs-pinning-service-with-textile-9d366da4e420

Either we should update really or at least notify people that some of the APIs has changed so checkout docs.textile.

In the Tour of Textile, some example commands use the address 127.0.0.1, like this:

textile comments add "Is this an outlier?" --block="QmUvWjstQzR6y7UctRJgVjcKsKzutZoiBsQw6WBXMnmg84" --api="http://127.0.0.1:41600"

While others use its alias, localhost, like this:

textile chat --thread="12D3KooWExn4ut4RV2qHXFSiWb3AfhL2whB8vJgYpnDcmVCG7UBv" --api="http://localhost:41600"

I think it would be clearer to choose one and stick to it throughout the guide, but I'm not sure what the pros and cons of each are, or if it's merely a stylistic decision. If we come to a consensus on which one to use I will update the docs to reflect it.

See https://github.com/textileio/go-textile/releases/tag/v0.4.1 for changes. The only user-facing change is target -> data links for files.

In the tabs of the tour we call it JS-HTTP. So, proposing a couple changes to that.

1. We can state near the beginning that Javascript examples will require the HTTP API.
2. We just call that tab, Javascript
3. We make sure all the code in those examples Browser compatible not node.js compat (which at least the File add one is currently I think)

https://docs.textile.io/concepts/threads/schemas#media