Docs: Refocus docs #168
Merged
Docs: Refocus docs #168
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
## Description 📝 Adds a new guide on decision making with PromptQL, highlighting patterns like interrogation, hypothesis testing, and cross-source analysis. Also renames and relocates the automations guide to the top level for clearer discovery, adjusting the sidebar position to reflect the new structure. Adds supporting images for new sections. ## Quick Links 🚀 [Decision Making](https://add-decision-making.promptql-docs.pages.dev/decision-making/) --------- Co-authored-by: hasura-bot <[email protected]>
## Description 📝 Adds a how-to-talk to PromptQL section. This is primarily based off work with the ACT folks and from being embedded with them in conversations to end users. This section will expand, but for now, it covers a very quick read that we can provide as collateral to end users who are first exploring the product. ## Quick Links 🚀 [How to Talk to PromptQL](https://add-what-can-pql-do.promptql-docs.pages.dev/how-to-talk-to-promptql/)
## Description 📝 Adds a capabilities page in the style of others from the HEP. Fortunately, there's lots of opportunity for cross-linking at this point. ## Quick Links 🚀 [Capabilities](https://add-how-to-talk.promptql-docs.pages.dev/capabilities/)
## Description 📝 This PR adds a fully custom sidebar implementation for our docs, giving us complete control over structure, styling, and behavior. I replaced the default layout with a custom React component that uses a category config to group and order pages consistently, cleaned up sidebar labels, and improved visual clarity with a redesigned CSS file. This sets us up for more flexible sidebar behavior going forward.
Fixes mobile navigation by refactoring what was in the `index.tsx` for the sidebar into the respective mobile and desktop components.
## 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]>
## Description 📝 ## Quick Links 🚀 <!-- Links to the relevant place(s) in the CloudFlare Pages build. Wait for CF comment for link. --> ## Assertion Tests 🤖 <!-- Add assertions between the comments below to have ChatGPT check the quality of your docs contribution (Diff) and how well it integrates with existing docs. E.g., A user should be able to easily understand how to make a simple query. --> <!-- For more info, see the Action's docs in the marketplace: https://github.com/marketplace/actions/docs-assertion-tester#usage --> <!-- DX:Assertion-start --> <!-- DX:Assertion-end -->
Redirects 🔀Hey, @robertjdominguez — the following redirects will be needed for deployment: |
|
@robertjdominguez Thanks for your PR! I've assigned @robertjdominguez to review it. |
Deploying promptql-docs with
|
| Latest commit: |
e05164d
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://0ddd2743.promptql-docs.pages.dev |
| Branch Preview URL: | https://robdominguez-feature-refocus.promptql-docs.pages.dev |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description 📝
Feature branch containing all of the Milestone One changes for our project to refocus docs on customer personas.
Quick Links 🚀
Index