Open
Conversation
Member
Author
|
❄ |
There was a problem hiding this comment.
Pull Request Overview
This PR introduces new features for rendering Mermaid graphs in Promptbook by integrating reserved parameter handling and updating related type imports and markdown examples.
- Added reserved parameter support in the Mermaid rendering function
- Updated imports and adjusted file references for consistency
- Fixed documentation by adding a dedicated Knowledge section in the markdown example
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| src/conversion/prettify/renderPromptbookMermaid.ts | Implements reserved parameter support and updates mermaid rendering |
| examples/pipelines/25-simple-knowledge.book.md | Adds a Knowledge section with a note in the pipeline example |
| src/_packages/types.index.ts | Reorders and consolidates type imports |
| src/conversion/prettify/prettifyPipelineString.ts | Updates the import to point to the new renderPromptbookMermaid module |
Comments suppressed due to low confidence (2)
src/conversion/prettify/renderPromptbookMermaid.ts:34
- [nitpick] Using the cast 'really_any' reduces type safety and may be ambiguous; consider using a more precise type if feasible.
const isReservedParameter = RESERVED_PARAMETER_NAMES.includes(parameterName as really_any);
src/conversion/prettify/renderPromptbookMermaid.ts:38
- [nitpick] The fallback name 'knowledge' may be too generic; consider using a more descriptive identifier for reserved parameters.
return 'knowledge';
Comment on lines
+96
to
+97
| <!-- <- Note: Knowledge can be passed explicitelly or let it be injected automatically --> | ||
|
|
There was a problem hiding this comment.
The word 'explicitelly' is misspelled; consider correcting it to 'explicitly'.
Suggested change
| <!-- <- Note: Knowledge can be passed explicitelly or let it be injected automatically --> | |
| <!-- <- Note: Knowledge can be passed explicitly or let it be injected automatically --> |
f8dbde9 to
8e619dc
Compare
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
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.
No description provided.