Skip to content

Commit fe002f9

Browse files
Copilotdanmarshall
andcommitted
Revert built schema file and add value plugin docs to source schema
Co-authored-by: danmarshall <11507384+danmarshall@users.noreply.github.com>
1 parent 80501c1 commit fe002f9

3 files changed

Lines changed: 11 additions & 10 deletions

File tree

.github/copilot-instructions.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ Chartifact consists of several interoperating modules:
3131

3232
### Version Control
3333
- **Do NOT check in UMD build artifacts**: Files matching `*.umd.js` in `docs/dist/v1/` are build outputs and should not be committed in PRs
34+
- **Do NOT edit `docs/schema/idoc_v1.d.ts` directly**: This file is generated from `packages/schema-doc/src/`. Edit the source files in the schema-doc package instead
3435
- These files are generated during the build process and committing them creates unnecessary merge conflicts
3536

3637
## Project-Specific Conventions

docs/schema/idoc_v1.d.ts

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -286,16 +286,6 @@ interface InteractiveDocument {
286286
/**
287287
* Use markdown elements to be verbose and descriptive. Do not use as labels for interactive elements.
288288
* Embed dynamic variables in markdown using double curly braces {{variableId}} as a placeholder for their values.
289-
*
290-
* Markdown Fence Blocks for Inline Data:
291-
* - CSV: ```csv variableId (content is CSV rows)
292-
* - TSV: ```tsv variableId (content is TSV rows)
293-
* - DSV: ```dsv delimiter:| variableId (content is delimiter-separated rows)
294-
* - JSON Value: ```json value variableId (content is JSON array or object)
295-
* - YAML Value: ```yaml value variableId (content is YAML array or object)
296-
*
297-
* The value plugin (JSON/YAML) is useful for inline structured data with type preservation (numbers, booleans, nested objects).
298-
* CSV/TSV/DSV store everything as strings and are better for tabular data.
299289
*/
300290
type MarkdownElement = string;
301291
/** Union type for all possible elements */

packages/schema-doc/src/page.ts

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,16 @@ export interface InteractiveDocument {
4141
/**
4242
* Use markdown elements to be verbose and descriptive. Do not use as labels for interactive elements.
4343
* Embed dynamic variables in markdown using double curly braces {{variableId}} as a placeholder for their values.
44+
*
45+
* Markdown Fence Blocks for Inline Data:
46+
* - CSV: ```csv variableId (content is CSV rows)
47+
* - TSV: ```tsv variableId (content is TSV rows)
48+
* - DSV: ```dsv delimiter:| variableId (content is delimiter-separated rows)
49+
* - JSON Value: ```json value variableId (content is JSON array or object)
50+
* - YAML Value: ```yaml value variableId (content is YAML array or object)
51+
*
52+
* The value plugin (JSON/YAML) is useful for inline structured data with type preservation (numbers, booleans, nested objects).
53+
* CSV/TSV/DSV store everything as strings and are better for tabular data.
4454
*/
4555
export type MarkdownElement = string;
4656

0 commit comments

Comments
 (0)