refactored docs (markdown files) to be MDX v3 compatible #1406
Conversation
✅ Deploy Preview for fdc3 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
| @@ -1,4 +1,4 @@ | |||
| # <a href='http://fdc3.finos.org/toolbox/fdc3-explained'><img src='logo.png' alt='FDC3 Explained Logo'></a> | |||
| # <a href='http://fdc3.finos.org/toolbox/fdc3-explained'><img src='logo.png' alt='FDC3 Explained Logo'/></a> | |||
There was a problem hiding this comment.
Doubling up on closing the tag
| # <a href='http://fdc3.finos.org/toolbox/fdc3-explained'><img src='logo.png' alt='FDC3 Explained Logo'/></a> | |
| # <a href='http://fdc3.finos.org/toolbox/fdc3-explained'><img src='logo.png' alt='FDC3 Explained Logo'/> |
There was a problem hiding this comment.
Hi @DILPREET1910, many thanks for taking this on. We have another overlapping PR #1409 that also addresses #1371 which we may need to combine with this one - there are merits to both and corrections are needed in both. It might be worth comparing the two PRs, see:
- sivaprasadanakarla/FDC3@sivaprasadanakarla:FDC3:main...DILPREET1910:FDC3:main
- DILPREET1910/FDC3@main...sivaprasadanakarla:FDC3:main
In particular, take a look at the script that generates the /docs/context/ref* pages in the latest version, see:
https://github.com/DILPREET1910/FDC3/blob/7ff9414ba88af3f9811f4e4d85795f9cf8062290/website/schema2Markdown.js#L186
As that script is not updated, your corrections to the context ref page in the main/unreleased version will be lost on deploy.
|
|
||
| ## Type | ||
|
|
||
| `fdc3.action` | ||
|
|
||
| ## Properties | ||
|
|
||
| <details> |
There was a problem hiding this comment.
A previous PR did not include generated code for this, not a change created in this PR and can be ignored.
| @@ -17,7 +17,7 @@ In addition to handling requests to plot charts, a charting application may use | |||
|
|
|||
| ## Schema | |||
|
|
|||
| <https://fdc3.finos.org/schemas/next/context/chart.schema.json> ([github](https://github.com/finos/FDC3/tree/main/schemas/context/chart.schema.json)) | |||
| [https://fdc3.finos.org/schemas/next/context/chart.schema.json](https://fdc3.finos.org/schemas/next/context/chart.schema.json) ([github](https://github.com/finos/FDC3/tree/main/schemas/context/chart.schema.json)) | |||
There was a problem hiding this comment.
Changes like this will be wiped out when these pages are regenerated by /website/schema2markdown.ts ... That script needs adjusting and using to make these changes
| | `style` | string | No | one of: `'line'`, `'bar'`, `'stacked-bar'`, `'mountain'`, `'candle'`, `'pie'`, `'scatter'`, `'histogram'`, `'heatmap'`, `'custom'` | | ||
| | `otherConfig`* | object | No | `{ /* unstandardized additional config */}` | | ||
| | `otherConfig`* | object | No | `\{ /* unstandardized additional config */\}` | |
There was a problem hiding this comment.
Because its not wrapped in a <pre> tag the escape on this line becomes visible in the output:
Probably best to add the <pre> tag
| @@ -21,7 +21,7 @@ https://fdc3.finos.org/schemas/2.0/email.schema.json | |||
| | Property | Type | Required | Example Value | | |||
| |-------------------|---------------------------------------|----------|---------------------| | |||
| | `type` | string | Yes | `'fdc3.email'` | | |||
| | `recipients` | fdc3.contact or fdc3.contactList | Yes | { type: "fdc3.contact", name: "John Doe", id: { "email": "[email protected]"}} | | |||
| | `recipients` | fdc3.contact or fdc3.contactList | Yes | \{ type: "fdc3.contact", name: "John Doe", id: \{ "email": "[email protected]"\}\} | | |||
There was a problem hiding this comment.
wrap example in a <pre> tag
|
|
||
| ## Details | ||
|
|
||
| | Property | Type | Required | Example Value | | ||
| |-------------------|-------------------------------------------|----------|-------------------------| | ||
| | `type` | string | Yes | `'fdc3.message'` | | ||
| | `text` | map of string mime-type to string content | No | { text/plain: 'Hello' } | | ||
| | `text` | map of string mime-type to string content | No | \{ text/plain: 'Hello' \} | |
There was a problem hiding this comment.
Should probably be wrapped in a pre tag
|
Thanks for the review @kriswest. Closing this PR in favor of #1418 |
Summary
Updated docs—markdown files to be MDX v3 compatible as required by docusaurus v3.5.2
Output of
npx docusaurus-mdx-checker:Next Steps
on track to fix: #1371