DSD-DBS / capella-collab-manager

A web app for collaboration on Capella (MBSE) projects
https://dsd-dbs.github.io/capella-collab-manager/
Apache License 2.0
20 stars 3 forks source link

docs: Update tool examples to latest configuration #1605

Closed MoritzWeber0 closed 2 months ago

github-actions[bot] commented 2 months ago

A Storybook preview is available for commit 147f0e8f6231d75373c009f5c52cd4312a78ae49. View Storybook View Chromatic build

codecov[bot] commented 2 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 79.81%. Comparing base (561e5f4) to head (dacaa25).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #1605 +/- ## ======================================= Coverage 79.81% 79.81% ======================================= Files 185 185 Lines 5970 5970 Branches 666 666 ======================================= Hits 4765 4765 Misses 1061 1061 Partials 144 144 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

sonarcloud[bot] commented 2 months ago

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

jamilraichouni commented 2 months ago

I'd like to know, why the whole code listing block (starting with triple backticks) is indented below that === "Capella/Papyrus/Eclipse" heading. Why are lines 324 and following indented?

image

The rendered output shows, that there is something wrong. We have no syntax highlighting and the first line (see marker on the screenshot) should not be part of the code listing:

image
jamilraichouni commented 2 months ago

In Markdown I do not know the meaning of a === prefix which seems to have no rendering style effect:

=== "Capella/Papyrus/Eclipse"

MoritzWeber0 commented 2 months ago

In Markdown I do not know the meaning of a === prefix which seems to have no rendering style effect:

=== "Capella/Papyrus/Eclipse"

We don't use Markdown, we use mkdocs-material for the documentation, which has more features. The rendered output looks good for me: https://capella-collab-manager--1605.org.readthedocs.build/1605/admin/tools/configuration/#configuration-examples

jamilraichouni commented 2 months ago

In Markdown I do not know the meaning of a === prefix which seems to have no rendering style effect: === "Capella/Papyrus/Eclipse"

We don't use Markdown, we use mkdocs-material for the documentation, which has more features. The rendered output looks good for me: https://capella-collab-manager--1605.org.readthedocs.build/1605/admin/tools/configuration/#configuration-examples

Ah, sorry. Have not used that so far and because of the file extension I thought this is supposed to be Markdown.