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

Unclear glossary of ThreadsDB terms #132

Open
theefer opened this issue May 5, 2020 · 2 comments
Open

Unclear glossary of ThreadsDB terms #132

theefer opened this issue May 5, 2020 · 2 comments

Comments

@theefer
Copy link
Contributor

theefer commented May 5, 2020

There seem to be a lot of similar concepts that aren't fully explained in the docs. Collections allude to Stores, but it's not clear what the latter mean exactly. I'm not not entirely clear on the distinction between Thread and Database. A more exhaustive glossary of the terms and how they relate to each other would really help.

@carsonfarmer
Copy link
Member

Thanks @theefer, very helpful. We're still in the 'first pass' phase of docs, so these types of tickets are super useful. Do you have a nice example of an effective glossary setup that you've seen elsewhere?

@theefer
Copy link
Contributor Author

theefer commented May 5, 2020

I'm not sure to be honest, maybe a start would be simply to make sure all terms are defined. https://docs.textile.io/threads/introduction/#basic-usage has many of them, but not "thread" or "store".

Actually thread is sort of defined as:

Everything above just looks like a Database, so what's a Thread? ThreadsDB combines the storage and management of data (the Database) with networking, access control, and replication over IPFS using the Threads Protocol. The Threads protocol has been extensively documented in the [whitepaper], but in short, Threads use private-key encryption to manage both security and identity among multiple parties that can access or edit the same Database.

But I'm not sure that paragraph necessarily makes it very clear what "a thread" is.

I'm also often a fan of diagrams that explain concepts and their relationships, but I know it's not always the easiest tool.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants