Skip to content

docs: improve metamodel reference - #748

Merged
MaximilianSoerenPollak merged 7 commits into
eclipse-score:mainfrom
etas-contrib:meta
Aug 27, 2026
Merged

docs: improve metamodel reference#748
MaximilianSoerenPollak merged 7 commits into
eclipse-score:mainfrom
etas-contrib:meta

Conversation

@AlexanderLanin

@AlexanderLanin AlexanderLanin commented Aug 24, 2026

Copy link
Copy Markdown
Member

Review 1: is it readable etc? see rendered page

Review 2: should we make the code more readable via OOP?

@github-actions

github-actions Bot commented Aug 24, 2026

Copy link
Copy Markdown
Contributor

License Check Results

🚀 The license check job ran with the Bazel command:

bazel run --lockfile_mode=error //src:license-check

Status: ⚠️ Needs Review

Click to expand output
[License Check Output]
Extracting Bazel installation...
Starting local Bazel server (8.6.0) and connecting to it...
INFO: Invocation ID: b05d0505-0f02-4037-a0e9-d044251dbfa7
Computing main repo mapping: 
Loading: 
Loading: 0 packages loaded
Loading: 0 packages loaded
Loading: 0 packages loaded
    currently loading: src
WARNING: Target pattern parsing failed.
ERROR: Skipping '//src:license-check': no such target '//src:license-check': target 'license-check' not declared in package 'src' defined by /home/runner/work/docs-as-code/docs-as-code/src/BUILD
ERROR: no such target '//src:license-check': target 'license-check' not declared in package 'src' defined by /home/runner/work/docs-as-code/docs-as-code/src/BUILD
INFO: Elapsed time: 6.197s
INFO: 0 processes.
ERROR: Build did NOT complete successfully
ERROR: Build failed. Not running target

@github-actions

Copy link
Copy Markdown
Contributor

Documentation preview for this pull request is available at:
pr-748: https://eclipse-score.github.io/docs-as-code/pr-748/

a-zw
a-zw previously requested changes Aug 25, 2026

@a-zw a-zw left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To be honest, I hate this. It is too much waste. Personally, I will rather look at the YAML file again.

Comment thread src/extensions/score_metamodel/docs/generate_metamodel_rst.py Outdated
Comment thread src/extensions/score_metamodel/docs/generate_metamodel_rst.py
Comment thread src/extensions/score_metamodel/docs/generate_metamodel_rst.py Outdated

@MaximilianSoerenPollak MaximilianSoerenPollak left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From my side this is okay.
Though it seems to get more and more unmaintainable with updates so we should ensure that it's not such a mess in the end that we don't understand it anymore.

I would also wait for @a-zw to be alright with this being merged as he had comments regarding it.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Refactors and expands the generated metamodel reference.

Changes:

  • Introduces typed models and dedicated Mermaid/RST renderers.
  • Adds per-type diagrams and collapsible option/link tables.
  • Updates the generated-documentation reference link.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

File Description
generate_metamodel_rst.py Refactors and expands reference generation.
BUILD Reformats generated outputs.
generated_docs.rst Updates the metamodel reference link.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread src/extensions/score_metamodel/docs/generate_metamodel_rst.py Outdated
Comment thread docs/how-to/generated_docs.rst Outdated
@RolandJentschETAS

Copy link
Copy Markdown
Contributor

Some texts are cutted
grafik

@AlexanderLanin

Copy link
Copy Markdown
Member Author

Fixed in the pending worktree changes: Mermaid SVGs no longer use fixed 167/333px heights; they use automatic height so rendered text is not clipped. The changes remain intentionally uncommitted.

@AlexanderLanin

Copy link
Copy Markdown
Member Author

Korrektur zum vorherigen Kommentar: Die automatische SVG-Höhe wurde auf Wunsch zurückgenommen und die ursprüngliche feste Höhenlogik (167/333 px bzw. Standardhöhe) wiederhergestellt. Der Screenshot-Befund bleibt damit bewusst offen.

@AlexanderLanin

Copy link
Copy Markdown
Member Author

Some texts are cutted grafik

cannot reproduce. this basically shows that the browser is not supported by mermaid. we can try updating mermaid.

@MaximilianSoerenPollak
MaximilianSoerenPollak merged commit 990935f into eclipse-score:main Aug 27, 2026
16 of 17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Development

Successfully merging this pull request may close these issues.

5 participants