Skip to content

docs: update docs-as-code tool verification report to 7.0.1 - #3180

Open
a-zw wants to merge 9 commits into
eclipse-score:mainfrom
etas-contrib:docs-as-code-tool-verification
Open

docs: update docs-as-code tool verification report to 7.0.1#3180
a-zw wants to merge 9 commits into
eclipse-score:mainfrom
etas-contrib:docs-as-code-tool-verification

Conversation

@a-zw

@a-zw a-zw commented Aug 12, 2026

Copy link
Copy Markdown
Contributor

@github-actions

Copy link
Copy Markdown
Contributor

The created documentation from the pull request is available at: docu-html

@masc2023 masc2023 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.

Comment thread docs/score_tools/tools_documentation/doc_as_code.rst Outdated
Comment thread docs/score_tools/tools_documentation/doc_as_code.rst
Comment thread docs/score_tools/tools_documentation/doc_as_code.rst Outdated
- flip LOW/HIGH according to S-CORE process
- consistently mention RST + Markdown
- update version in overview table
@a-zw
a-zw requested a review from masc2023 August 12, 2026 14:45
Comment thread docs/score_tools/tools_documentation/doc_as_code.rst Outdated
Comment thread docs/score_tools/tools_documentation/_assets/doc_as_code.drawio.svg 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.

Thanks for the writeup, overall I really like it.
I found a couple of things that we might want to address but other than that looks good from my side.

Comment thread docs/score_tools/tools_documentation/doc_as_code.rst Outdated
Comment thread docs/score_tools/tools_documentation/doc_as_code.rst Outdated
Comment thread docs/score_tools/tools_documentation/doc_as_code.rst Outdated
@masc2023 masc2023 changed the title docs: update docs-as-code verification report to 7.0.1 docs: update docs-as-code tool verification report to 7.0.1 Aug 13, 2026
Comment thread docs/score_tools/tools_documentation/doc_as_code.rst Outdated
@a-zw

a-zw commented Aug 13, 2026

Copy link
Copy Markdown
Contributor Author

Just for reference, this PR was shortly discussed in https://github.com/orgs/eclipse-score/discussions/407#discussioncomment-17998359

- TI0 -> TI1
- tenets are not used in practice
- recreate a diagram
- mention source- and testlinks
- remove outdated capabilities link
- clarify T1 measures
@a-zw
a-zw requested a review from PandaeDo as a code owner August 13, 2026 09:35
@a-zw
a-zw requested a review from masc2023 August 13, 2026 09:44

@aschemmel-tech aschemmel-tech 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.

see inline comments

Comment thread docs/score_tools/tools_documentation/doc_as_code.rst Outdated
Comment thread docs/score_tools/tools_documentation/doc_as_code.rst Outdated
Comment thread docs/score_tools/tools_documentation/doc_as_code.rst Outdated
Comment thread docs/score_tools/tools_documentation/doc_as_code.rst Outdated
Comment thread docs/score_tools/tools_documentation/doc_as_code.rst Outdated
Comment thread docs/score_tools/tools_documentation/doc_as_code.rst Outdated
Comment thread docs/score_tools/tools_documentation/doc_as_code.rst Outdated
Comment thread docs/score_tools/tools_documentation/doc_as_code.rst Outdated
Comment thread docs/score_tools/tools_documentation/doc_as_code.rst Outdated
Comment thread docs/score_tools/tools_documentation/doc_as_code.rst Outdated
@a-zw
a-zw force-pushed the docs-as-code-tool-verification branch from f886d31 to fbced48 Compare August 14, 2026 10:09
@a-zw

a-zw commented Aug 17, 2026

Copy link
Copy Markdown
Contributor Author

I essentially rewrote it completely.

@a-zw
a-zw requested a review from aschemmel-tech August 17, 2026 13:11
Comment thread docs/score_tools/tools_documentation/doc_as_code.rst Outdated
Comment thread docs/score_tools/tools_documentation/doc_as_code.rst Outdated

@aschemmel-tech aschemmel-tech 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.

updated comments (three stay unresolved) and added one

* remove traces of quality gate
* no rl_committer
* add use case: Listing assumptions of use
* do not mention PlantUML/Mermaid for arch diagrams

@aschemmel-tech aschemmel-tech 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.

added suggestions

Comment thread docs/score_tools/tools_documentation/doc_as_code.rst
Comment thread docs/score_tools/tools_documentation/doc_as_code.rst
Comment thread docs/score_tools/tools_documentation/doc_as_code.rst Outdated
Comment thread docs/score_tools/tools_documentation/doc_as_code.rst Outdated
@github-actions

Copy link
Copy Markdown
Contributor

Documentation preview for this pull request is available at:
pr-3180: https://eclipse-score.github.io/score/pr-3180/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Backlog
Status: No status

Development

Successfully merging this pull request may close these issues.

5 participants