Plans: prompt management docs structure and pre-release concerns#1869
Draft
Plans: prompt management docs structure and pre-release concerns#1869
Conversation
Deploying logfire-docs with
|
| Latest commit: |
53ed315
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://fb991fa1.logfire-docs.pages.dev |
| Branch Preview URL: | https://petyo-prompt-management.logfire-docs.pages.dev |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Adds two planning documents to
plans/from a review of the prompt-management branch in the platform repo:plans/prompt-mgmt-release-concerns.md— severity-sorted list of seven concerns found while examining the branch against the goal of writing customer-facing docs. Each concern includes evidence (file:line citations), why-it-matters, and what needs to change. Four are marked release-blocking; three are ship-acceptable with honest docs but each has a low-cost product fix.plans/prompt-mgmt-docs-structure.md— a page-by-page documentation plan for Prompt Management. Each page brief states audience, required content, claims that cannot yet be made, and the specific concern (if any) that blocks publication. A "Drafting sequence" section partitions pages into draft-now, draft-and-hold, and grammar-blocked buckets.The two documents are designed to be read together: the concerns drive the "blocked on" notes in the structure, and the structure shows where each concern surfaces as a user-visible docs problem.
Why draft
The concerns reference product decisions (template grammar, versioning scope, release shape) that have not been resolved yet. Merging is premature; the PR is a venue for review and alignment on which concerns are in scope for this release.