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

Add non-technical description of OrbitDB #527

Closed
sirfumblestone opened this issue Dec 17, 2018 · 3 comments
Closed

Add non-technical description of OrbitDB #527

sirfumblestone opened this issue Dec 17, 2018 · 3 comments
Labels
docs Documentation related.

Comments

@sirfumblestone
Copy link

It would be great to see also a non-technical description of OrbitDB (e.g. key features and capabilities). At the moment they might not be that evident if you are not experience developer and familiar with database models/types. I believe this kind of information would serve well people who are not so much (at least not yet) into database internals but are on quest of finding new tech 🖖

@sirfumblestone
Copy link
Author

Would it make sense to add a bit more verbose description to README?

@sirfumblestone sirfumblestone added the docs Documentation related. label Dec 17, 2018
@RichardLitt
Copy link
Member

I think that this could go in a Background section above the Usage section. But I'm not sure that this needs to be expounded upon in great depth in this repository, in general. I think it might belong in a blog post or in a tutorial, rather, or on an orbitdb-related website.

@aphelionz
Copy link
Member

Resolved via the Field Manual. Feel free to open any tickets there in case that section is unclear

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

No branches or pull requests

3 participants