textileio / community Goto Github PK
View Code? Open in Web Editor NEWTextile community repo. Includes a sub-project for documentation ๐ and a discussion board for ideas & questions.
Home Page: https://docs.textile.io/
License: MIT License
Textile community repo. Includes a sub-project for documentation ๐ and a discussion board for ideas & questions.
Home Page: https://docs.textile.io/
License: MIT License
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.
The command line API has changed. This needs to be updated in the tour to match version 0.5.0 at least.
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.
The use of plaintext should be more thoroughly explained for cases where threads or apps could benefit from pinning unencrypted data in threads
In the tabs of the tour we call it JS-HTTP. So, proposing a couple changes to that.
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.
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.
Needs a section for blocks.
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.
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.
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
We should just add our .circleci configs to docs in some way
Critical
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.
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:
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.
Needs a section for schemas and a section for mills.
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?
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:
textile invites accept "QmWcd5RoyFBsA65EKiJRNsmhoDLADTgRXdri469Fj9nndN" --api="http://127.0.0.1:41600"
)--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.
This is a regression from switching to HTML based docs for the command line client.
The current one is hitting a very old deprecated cafe.
Renaming this one to... just "write all the docs"
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,
We should go through and document just what happens during different type of removals in Textile.
Couldn't find info on source
, checksum
is self explanatory but could still use a line in here, etc.
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.