chore: add plugin documentation #3636
Conversation
|
PR in the developers portal: dhis2/developer-portal#152 |
There was a problem hiding this comment.
Hey,
In the Github preview for the newly added files there are some syntaxes that are not displayed correctly (warnings, tips, images, etc.). I suggested some alternatives using regular markdown syntax, but I'm not sure if this is a cause for concern or if it will compile and display correctly in the developer portal.
Thanks!
docs/developer/getting-started.md
Outdated
|
|
||
| 1. Log in to your DHIS2 system and open the data store management app. It should look something like this. | ||
|
|
||
| <img src={require("./resources/data-store-management-app.png").default} alt="Data store management app" /> |
There was a problem hiding this comment.
| # Getting started | ||
|
|
||
| --- | ||
| :::warning Experimental feature |
| @@ -0,0 +1,292 @@ | |||
| import Tabs from '@theme/Tabs'; | |||
There was a problem hiding this comment.
The JSX syntax in this .mdx file does not appear to display correctly. Are there any packages or configurations missing to get it working?
|
Hey again! Thanks for the review @simonadomnisoru. I actually ended up rewriting most of the documentation as it was not great. I'm aware that the preview functionality in GitHub does not really deal with mdx and docusaurus syntax very well, but you can inspect the final result here: It does seem to be parsed and displayed correctly here! Please have a look and get back to me 👍 |
This PR adds the plugin developer documentation. This documentation will be hosted on the developers portal.