Documention of the site-schema
QA
-
Open https://www.npmjs.com/package/@paroicms/server and open the documentation regarding site schemas
Implementation
To do:
- Add jsdoc comments for each interface, type, propertie of
app/server/src/typeonly/site-schema-json-types.d.ts
. It is important to explain the usage of each one. - Find a tool in order to manually generate a standalone HTML file with minimal embed CSS or a markdown file
- Save this file in
documentation/site-schema.html
Then, edit app/server/README.md
and add a link to this documentation:
## Documentation
- [Documentation on site schemas](https://gitlab.com/paroi/opensource/paroicms/-/blob/main/documentation/site-schema.html)
Edited by Thomas Mur