Skip to content

docs: add a narrated walkthrough to the home page#316

Open
siderakis wants to merge 1 commit into
danvergara:mainfrom
siderakis:docs/add-narrated-walkthrough
Open

docs: add a narrated walkthrough to the home page#316
siderakis wants to merge 1 commit into
danvergara:mainfrom
siderakis:docs/add-narrated-walkthrough

Conversation

@siderakis

Copy link
Copy Markdown

Description

Adds a short (~2 min) narrated walkthrough embedded near the top of the docs home page — a quick "what is dblab + the keyboard-driven tour": connect, browse the tables tree, run a query, read results, all without the mouse. A fast orientation for first-time visitors.

It's a single responsive, lazy-loaded <iframe> embedding a Bisque-hosted presentation. No scripts, no dependencies, no build/config changes — one file changed (docs/index.md), six lines added. md_in_html is already enabled, so the raw HTML block renders as-is.

Not tied to an existing issue.

Type of change

  • This change requires a documentation update (docs-only — adds the embed)

How Has This Been Tested?

  • Verified the page renders with the embed in place (MkDocs Material, indigo theme).
  • Confirmed the presentation URL is public (loads without sign-in).
  • Re-checked every command and keybinding narrated against the current docs (home, quickstart, navigation, config file).

Checklist:

  • My code follows the style guidelines of this project (docs-only; Conventional Commit title)
  • I have performed a self-review of my own change
  • I have made corresponding changes to the documentation (this is the docs change)
  • I have checked my change and corrected any misspellings

Unit-test items are N/A — docs-only, no code paths touched. Happy to adjust placement/wording or close if it's not a fit.

Preview of the embedded presentation: https://bisque.cloud/p/github/danvergara-dblab

@danvergara

Copy link
Copy Markdown
Owner

Thanks for taking the time for this!

I like the video, it seems very helpful for newcomers.
Is it too much to ask if you can embed it in the main README.md file? Maybe in the Overview section, please?

@danvergara danvergara self-assigned this Jul 18, 2026
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

Successfully merging this pull request may close these issues.

2 participants