typedb/typedb-docs

Basic TypeDB Studio documentation

Closed this issue · 1 comments

Problem to Solve

image

Proposed Solution

We should update docs once we're done developing Studio, since the docs are still full of Workbase screenshots. Given that Studio is largely self-documenting, the best thing to do on the short-term is to create a simple one-page document that describes what Studio is and does.

There is a page explaining how to install and run TypeDB, and we should make a similar page for Studio (but in the Studio section, not in its own section). Admittedly, the process is relatively straightforward, unless you're on a non-Debian Linux system, then you at least have to untar a tar, install Java and run a shell binary. Nonetheless we should quickly document it.

Further down the line, we can do:

Closed by: