Add v3 docs (and convenience scripts for working with docs) #327
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.json
for 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 prepare
npm run docs:prepare
npm run docs:build
to build the docs indocs/build/html
-- or --
npm run docs:watch
, to preview the docs onlocalhost:8088
The following requirements should be met:
Apollon API
entry on the docs (built or previewed) should be updated to reflect model 3 schemaUML Model Helpers
entry on the docs (built or previewed) should be found, detailing the helper functions with sufficient clarity.Screenshots