Docs: Create best practices documentation for promptql metadata #177
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 Moves `system-instructions.mdx` to the `/metadata` directory after the relevant metadata objects. In subsequent commits, we'll build context on this page to make it clear what belongs in system instructions and what doesn't (i.e., what should be in relevant metadata objects' pages).
Adds details for system instructions by stealing what makes sense in the ACT folks' Confluence.
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: |
5c2ccd0
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://96b33105.promptql-docs.pages.dev |
| Branch Preview URL: | https://robdominguez-doc-2957-create.promptql-docs.pages.dev |
sandalsoft
approved these changes
Jul 10, 2025
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 📝
Moves
system-instructions.mdxto the/metadatadirectory after the relevant metadata objects. In subsequent commits, we'll build context on this page to make it clear what belongs in system instructions and what doesn't (i.e., what should be in relevant metadata objects' pages).Adds details for system instructions by stealing what makes sense in the ACT folks' Confluence.
Quick Links 🚀
System Instructions