Skip to content

Conversation

robertjdominguez
Copy link
Collaborator

Description

Enhanced DocsBot validation to prevent cross-platform confusion:

  • Added strict enforcement rules to prevent mixing PromptQL syntax with other GraphQL systems
  • Implemented mandatory validation step before providing any code examples or CLI commands
  • Added explicit warnings against assuming Hasura GraphQL Engine patterns apply to PromptQL

Previously, the bot could accidentally provide syntax from similar systems:

    <code_example_constraints>
    - NEVER provide code examples with invented class names, method names, or APIs
    - If specific syntax/names aren't found in documentation, state "I need to find the exact syntax" and search further
    - When providing code examples, ALWAYS preface with "Based on the documentation, here's the exact syntax:" and cite the source
    - Use placeholder comments like "// Use actual error class from documentation" rather than inventing names
    </code_example_constraints>

Now the bot has explicit guardrails against platform confusion:

    <strict_validation_enforcement>
    CRITICAL: PromptQL is NOT Hasura GraphQL Engine, Hasura Cloud, or any other GraphQL system. 

    Before providing ANY configuration syntax, CLI commands, or code examples:
    1. STOP and explicitly state "Let me validate this syntax against the PromptQL documentation"
    2. Search the documentation for the exact syntax being requested
    3. NEVER assume syntax from other systems applies to PromptQL
    4. If you catch yourself thinking "this is similar to [other system]" - STOP and validate instead
    </strict_validation_enforcement>

This prevents the bot from making dangerous assumptions about syntax compatibility between PromptQL and other GraphQL platforms. The mandatory validation step ensures users get accurate, PromptQL-specific guidance rather than potentially incorrect syntax borrowed from similar but different systems.

Copy link

github-actions bot commented Aug 6, 2025

🚀 PromptQL Build Complete

Build Version: 8cf6f5b05a
Project: pql-docs
PromptQL Playground: Open Playground

Description: PR #34: PQL: Add stricter validation instructions for familiar GQL concepts

@robertjdominguez robertjdominguez merged commit 519690a into main Aug 6, 2025
1 check passed
@robertjdominguez robertjdominguez deleted the rob/pql/add-stricter-validation-for-gql-familiarity branch August 6, 2025 15:17
Copy link

github-actions bot commented Aug 6, 2025

✅ PromptQL Build Applied

Build Version: 8cf6f5b05a
Status: Successfully applied to production
Applied at: 2025-08-06T15:18:16.855Z

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

## Description

Enhanced DocsBot validation to prevent cross-platform confusion:

- Added strict enforcement rules to prevent mixing PromptQL syntax with
other GraphQL systems
- Implemented mandatory validation step before providing any code
examples or CLI commands
- Added explicit warnings against assuming Hasura GraphQL Engine
patterns apply to PromptQL

Previously, the bot could accidentally provide syntax from similar
systems:

````yaml path=pql/globals/metadata/promptql-config.hml mode=EXCERPT
    <code_example_constraints>
    - NEVER provide code examples with invented class names, method names, or APIs
    - If specific syntax/names aren't found in documentation, state "I need to find the exact syntax" and search further
    - When providing code examples, ALWAYS preface with "Based on the documentation, here's the exact syntax:" and cite the source
    - Use placeholder comments like "// Use actual error class from documentation" rather than inventing names
    </code_example_constraints>
````

Now the bot has explicit guardrails against platform confusion:

````yaml path=pql/globals/metadata/promptql-config.hml mode=EXCERPT
    <strict_validation_enforcement>
    CRITICAL: PromptQL is NOT Hasura GraphQL Engine, Hasura Cloud, or any other GraphQL system. 

    Before providing ANY configuration syntax, CLI commands, or code examples:
    1. STOP and explicitly state "Let me validate this syntax against the PromptQL documentation"
    2. Search the documentation for the exact syntax being requested
    3. NEVER assume syntax from other systems applies to PromptQL
    4. If you catch yourself thinking "this is similar to [other system]" - STOP and validate instead
    </strict_validation_enforcement>
````

This prevents the bot from making dangerous assumptions about syntax
compatibility between PromptQL and other GraphQL platforms. The
mandatory validation step ensures users get accurate, PromptQL-specific
guidance rather than potentially incorrect syntax borrowed from similar
but different systems.
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