Skip to content

Conversation

robertjdominguez
Copy link
Collaborator

Description 📝

  • Restructured documentation navigation to create a clearer, more intuitive developer workflow
  • Reorganized categories to follow the natural progression from project creation to production deployment
  • Renamed sections for better clarity and discoverability

Previously, our documentation structure was scattered across conceptual categories that didn't align with how developers actually build applications:

coreConcepts: {
  title: 'Core Concepts', 
  directories: ['architecture', 'data-sources', 'metadata', 'ai-primitives', 'business-logic', 'auth'],
  exactMatch: false,
},
buildingApps: {
  title: 'Building Apps',
  directories: ['project-configuration', 'how-to-build-with-promptql', 'promptql-apis', 'promptql-playground'],
  exactMatch: true,
},

Now, the documentation follows a logical build-test-deploy workflow that mirrors the actual development process:

coreConcepts: {
  title: 'Core Concepts', 
  directories: ['architecture', 'metadata', 'ai-primitives'],
  exactMatch: false,
},
buildingApps: {
  title: 'Building Apps',
  directories: ['create-a-project', 'data-sources', 'create-and-run-builds', 'evaluate-accuracy', 'configure-your-project', 'business-logic', 'create-automations', 'promptql-apis'],
  exactMatch: true,
},

The restructure creates a natural progression: developers start by creating a project, connect their data sources, build and test locally, evaluate accuracy, configure advanced features, add custom logic, create automations, and finally integrate via APIs. This eliminates the cognitive overhead of jumping between conceptual categories when following practical tutorials.

We've also renamed key sections for clarity - "Data Sources" becomes "Connect Data Sources", "Business Logic" becomes "Add Custom Business Logic", and "PromptQL APIs" becomes "APIs and SDKs" - making it immediately obvious what each section helps you accomplish.

@hasura-bot
Copy link
Collaborator

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

Copy link

Deploying promptql-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: f8b28ce
Status: ✅  Deploy successful!
Preview URL: https://34c9617d.promptql-docs.pages.dev
Branch Preview URL: https://robdominguez-doc-3073-publis.promptql-docs.pages.dev

View logs

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