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

Basic TypeDB Studio documentation #571

Closed
alexjpwalker opened this issue Nov 2, 2021 · 1 comment
Closed

Basic TypeDB Studio documentation #571

alexjpwalker opened this issue Nov 2, 2021 · 1 comment

Comments

@alexjpwalker
Copy link
Member

alexjpwalker commented Nov 2, 2021

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:

@alexjpwalker
Copy link
Member Author

alexjpwalker commented Jun 27, 2022

Closed by:

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

No branches or pull requests

3 participants