Skip to content

Docs: Refocus quickstart on end users #155

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

Conversation

robertjdominguez
Copy link
Collaborator

@robertjdominguez robertjdominguez commented Jun 18, 2025

Description 📝

Refocuses the quickstart on end users as part of the HEP: Iterating Docs to Re-Focus on Customer Personas.

At its current state, this is a DRAFT PR which works to succinctly highlight what happens whenever a user asks a question of PromptQL (decision-making use case). In a follow-up commit, we'll introduce the concept of automation (our other use case) and ensure we have a high-level overview of the two use cases, which illustrates how users are expected to interact with the product.

Quick Links 🚀

Quickstart

@hasura-bot
Copy link
Collaborator

@robertjdominguez Thanks for your PR! I've assigned @robertjdominguez to review it.

@hasura-bot
Copy link
Collaborator

Images automagically compressed by Calibre's image-actions

Compression reduced images by 63.6%, saving 1.60 MB.

Filename Before After Improvement Visual comparison
static/img/get-started/pql-artifact.png 438.61 KB 222.42 KB -49.3% View diff
static/img/get-started/pql-console-all-projects.png 392.85 KB 190.36 KB -51.5% View diff
static/img/get-started/pql-execution.png 408.67 KB 200.43 KB -51.0% View diff
static/img/get-started/pql-playground.png 215.38 KB 84.99 KB -60.5% View diff
static/img/get-started/pql-query-plan.png 423.68 KB 208.05 KB -50.9% View diff
static/img/og-promptql.jpg 703.60 KB 33.74 KB -95.2% View diff

108 images did not require optimisation.

Copy link

cloudflare-workers-and-pages bot commented Jun 18, 2025

Deploying promptql-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 196ff9e
Status: ✅  Deploy successful!
Preview URL: https://94c53061.promptql-docs.pages.dev
Branch Preview URL: https://robdominguez-doc-2900-redesi.promptql-docs.pages.dev

View logs

robertjdominguez and others added 2 commits June 30, 2025 07:48
Refocuses the quickstart on end users as part of the HEP: Iterating Docs to Re-Focus on Customer Personas.

At its current state, this is a `DRAFT` PR which works to succinctly highlight what happens whenever a user asks a question of PromptQL (decision making use case). In a follow-up commit,
we'll introduce the concept of automation (our other use case) and ensure we have a high-level overview between the two use cases which illustrates how users are expected to interact
with the product.
@robertjdominguez robertjdominguez force-pushed the robdominguez/doc-2900-redesign-quickstart-for-end-users branch from 3e0ea79 to a009bb2 Compare June 30, 2025 16:15
Fixes sidebar logo to be included again instead of empty space.
@robertjdominguez robertjdominguez force-pushed the robdominguez/doc-2900-redesign-quickstart-for-end-users branch from a009bb2 to 0d98ec1 Compare June 30, 2025 16:16
@robertjdominguez robertjdominguez changed the base branch from main to robdominguez/feature/refocus-docs June 30, 2025 16:17
@robertjdominguez robertjdominguez marked this pull request as ready for review June 30, 2025 18:45
@hasura-bot
Copy link
Collaborator

Images automagically compressed by Calibre's image-actions

Compression reduced images by 50.7%, saving 218.83 KB.

Filename Before After Improvement Visual comparison
static/img/get-started/playground-quickstart-automation.png 431.68 KB 212.85 KB -50.7% View diff

107 images did not require optimisation.

@robertjdominguez robertjdominguez merged commit 8034782 into robdominguez/feature/refocus-docs Jun 30, 2025
4 checks passed
@robertjdominguez robertjdominguez deleted the robdominguez/doc-2900-redesign-quickstart-for-end-users branch June 30, 2025 18:51
robertjdominguez added a commit that referenced this pull request Jun 30, 2025
## Description 📝

Refocuses the quickstart on end users as part of the HEP: Iterating Docs
to Re-Focus on Customer Personas.

At its current state, this is a `DRAFT` PR which works to succinctly
highlight what happens whenever a user asks a question of PromptQL
(decision-making use case). In a follow-up commit, we'll introduce the
concept of automation (our other use case) and ensure we have a
high-level overview of the two use cases, which illustrates how users
are expected to interact with the product.

## Quick Links 🚀


[Quickstart](https://robdominguez-doc-2900-redesi.promptql-docs.pages.dev/quickstart/)

---------

Co-authored-by: hasura-bot <[email protected]>
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