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

Interactive Documentation Experience #1420

Open
fulghum opened this issue May 17, 2023 · 0 comments
Open

Interactive Documentation Experience #1420

fulghum opened this issue May 17, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@fulghum
Copy link
Contributor

fulghum commented May 17, 2023

Our current documentation has some great content and great examples of using Dolt. It would be really cool if we could take it a step further and instead of just "reading" the documentation and examples, people could interact and experience Dolt. For example, on the system table references page, we have a lot of good, concrete examples on using Dolt's versioning features, but it would be more interactive and compelling if people could really run the queries themselves in DoltHub, change query values, and explore what Dolt can do. I think the system tables, functions, and procedures references would be natural places to start, but you could imagine this being used in many other places in the docs, too. Having something in a getting started experience doc would also be really great. Maybe even something we could re-use for blogs eventually?

Something like this could help Dolt customers more quickly understand how to use Dolt features and could help people brand new to Dolt quickly see the Dolt experience more deeply and get it under their fingers.

The major challenges I see with this are that some queries are going to run very slowly on DoltHub, either because of query slowness (which we should fix) or because of the latency for DoltHub to load a database (one way to get around this may be to allow list a set of "documentation" databases that we keep loaded somehow?). It will also be important that these queries consistently work over time – having a customer see the interactive experience and see it broken would be a really bad experience, so we'd want to be smart about building this in a way where we proactively learn if we broke something with a code change.

@fulghum fulghum added the documentation Improvements or additions to documentation label May 17, 2023
@fulghum fulghum transferred this issue from dolthub/dolt May 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant