[x] I documented the TypeScript code using JSDoc style (NA).
[x] I added multiple screenshots/screencasts of my UI changes
[x] I translated all the newly inserted strings into German and English (NA).
Motivation and Context
The documentation is outdated and needs updating. Specifically, the new V3 schema, and the new helper functions for working with Apollon UML models in a safe and backwards compatible manner, should be documented.
Description
This PR adds the following:
Documentation for new Apollon v3 schemas and helper functions.
New scripts in package.json for building docs and previewing them locally with auto-rebuild on change.
A fixes for a minro dependency issue in docs: the docs require Jinja < 3.1, but a higher version was being installed without explicitly specifying the version constraint (see this issue).
Instructions on README about how to build and work with the docs.
Steps for Testing
npm run prepare
npm run docs:prepare
npm run docs:build to build the docs in docs/build/html \
-- or -- \
npm run docs:watch, to preview the docs on localhost:8088
The following requirements should be met:
The scripts should work and should be explained properly by the README
Apollon API entry on the docs (built or previewed) should be updated to reflect model 3 schema
A new UML Model Helpers entry on the docs (built or previewed) should be found, detailing the helper functions with sufficient clarity.
Checklist
I documented the TypeScript code using JSDoc style(NA).I translated all the newly inserted strings into German and English(NA).Motivation and Context
The documentation is outdated and needs updating. Specifically, the new V3 schema, and the new helper functions for working with Apollon UML models in a safe and backwards compatible manner, should be documented.
Description
This PR adds the following:
package.jsonfor building docs and previewing them locally with auto-rebuild on change.Jinja < 3.1, but a higher version was being installed without explicitly specifying the version constraint (see this issue).Steps for Testing
npm run preparenpm run docs:preparenpm run docs:buildto build the docs indocs/build/html\ -- or -- \npm run docs:watch, to preview the docs onlocalhost:8088The following requirements should be met:
Apollon APIentry on the docs (built or previewed) should be updated to reflect model 3 schemaUML Model Helpersentry on the docs (built or previewed) should be found, detailing the helper functions with sufficient clarity.Screenshots