Skip to content

Conversation

robertjdominguez
Copy link
Collaborator

Description

  • Replaced overly complex artifact-checking protocols with targeted CLI and metadata validation while maintaining accuracy requirements

Previously, the DocsBot had a paranoid verification system that required checking every existing artifact before answering any question, creating unnecessary friction:

### Step 1: Check Existing Context First (MANDATORY)
Before fetching new documentation:
1. **ALWAYS check if any existing artifacts contain information relevant to the user's question**
2. **ALWAYS examine the actual content of existing artifacts, not just their titles or descriptions**

**VIOLATION CHECK: If you provide specific technical details (commands, syntax, flags, etc.) without first checking existing artifacts, you are violating this instruction and will be terminated.**

Now the system uses focused validation that targets the two most critical areas where accuracy matters - CLI commands and metadata objects:

## CLI Command Validation
Before providing any CLI command information to users, ALWAYS validate the command exists by checking the documentation:

1. **Check command existence**: Query `app.docs_bot_doc_content` for pages with URLs matching the pattern:
  `https://promptql.io/docs/reference/cli/commands/ddn_[command]_[subcommand]`

## Metadata Object Validation
Before discussing metadata objects, ALWAYS validate they exist and have examples:

1. **Check object existence**: Query `app.docs_bot_doc_content` for pages with URLs matching:
  `https://promptql.io/docs/reference/metadata-reference/[object-name]`

The changes eliminate the bureaucratic artifact management overhead while maintaining precision where it counts. Instead of forcing the bot to examine every piece of existing context before answering simple questions, it now applies targeted validation to CLI commands and metadata objects - the areas where hallucination would actually break user workflows. This keeps responses accurate without the performance penalty of mandatory artifact checking.

Copy link

🚀 PromptQL Build Complete

Build Version: 06cc26a240
Project: pql-docs
PromptQL Playground: Open Playground

Description: PR #19: PQL: Replace artifact protocols with targeted CLI/metadata checks

Copy link

No description provided.

@robertjdominguez robertjdominguez merged commit af404af into main Jul 30, 2025
1 check passed
@robertjdominguez robertjdominguez deleted the rob/pql/use-sandys-recs branch July 30, 2025 15:13
Copy link

✅ PromptQL Build Applied

Build Version: 06cc26a240
Status: Successfully applied to production
Applied at: 2025-07-30T15:13:23.790Z

robertjdominguez added a commit that referenced this pull request Aug 10, 2025
## Description

- Replaced overly complex artifact-checking protocols with targeted CLI
and metadata validation while maintaining accuracy requirements

Previously, the DocsBot had a paranoid verification system that required
checking every existing artifact before answering any question, creating
unnecessary friction:

````yaml path=pql/globals/metadata/promptql-config.hml mode=EXCERPT
### Step 1: Check Existing Context First (MANDATORY)
Before fetching new documentation:
1. **ALWAYS check if any existing artifacts contain information relevant to the user's question**
2. **ALWAYS examine the actual content of existing artifacts, not just their titles or descriptions**

**VIOLATION CHECK: If you provide specific technical details (commands, syntax, flags, etc.) without first checking existing artifacts, you are violating this instruction and will be terminated.**
````

Now the system uses focused validation that targets the two most
critical areas where accuracy matters - CLI commands and metadata
objects:

````yaml path=pql/globals/metadata/promptql-config.hml mode=EXCERPT
## CLI Command Validation
Before providing any CLI command information to users, ALWAYS validate the command exists by checking the documentation:

1. **Check command existence**: Query `app.docs_bot_doc_content` for pages with URLs matching the pattern:
  `https://promptql.io/docs/reference/cli/commands/ddn_[command]_[subcommand]`

## Metadata Object Validation
Before discussing metadata objects, ALWAYS validate they exist and have examples:

1. **Check object existence**: Query `app.docs_bot_doc_content` for pages with URLs matching:
  `https://promptql.io/docs/reference/metadata-reference/[object-name]`
````

The changes eliminate the bureaucratic artifact management overhead
while maintaining precision where it counts. Instead of forcing the bot
to examine every piece of existing context before answering simple
questions, it now applies targeted validation to CLI commands and
metadata objects - the areas where hallucination would actually break
user workflows. This keeps responses accurate without the performance
penalty of mandatory artifact checking.
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.

1 participant