Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add v3 docs (and convenience scripts for working with docs) #327

Merged
merged 4 commits into from
Nov 28, 2023

Conversation

loreanvictor
Copy link
Contributor

Checklist

  • I documented the TypeScript code using JSDoc style (NA).
  • I added multiple screenshots/screencasts of my UI changes
  • 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

  1. npm run prepare
  2. npm run docs:prepare
  3. 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.

Screenshots

Screenshot 2023-11-27 at 15 35 32

@matthiaslehnertum matthiaslehnertum merged commit ee70f75 into develop Nov 28, 2023
5 checks passed
@matthiaslehnertum matthiaslehnertum deleted the documentation/v3-docs-and-new-doc-scripts branch November 28, 2023 15:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants