Demo for trudag manage set

[Jonas-Kirchhoff]

This draft demonstrates how to set the review-status of items and links using the trudag tool. For demonstration purposes, the status of the item NJF-01 and the arrow WFJ-01 -> NJF-01 have been set to reviewed.

In order to ensure that the trudag tool works without additional configurations, it is recommended to execute the commands on the status of the branch review_round_2, or main after PR #92 is merged. Otherwise, we highly recommend to remove the reference of the statement JLS-16.

To set the review-status of an item stored as ITEM-NAME.md to reviewed using trudag, the command trudag manage set-item ITEM-NAME is used. In the example, the command would be trudag manage set-item NJF-01.

In case of an arrow FIRST-ITEM -> SECOND-ITEM, the command trudag manage set-link FIRST-ITEM SECOND-ITEM; in the example, the command would be trudag manage set-link WFJ-01 NJF-01.

This calculates the SHA-value of the item (link) and stores the calculated value in the file .dotstop.dot. It is strongly recommended to not edit this file manually.

In case of an falsely set item or arrow, e.g. due to a mis-typed number, we recommend, however, to keep a backup copy of the .dotstop.dot file on hand and to manually replace the mistakenly inserted sha with the original one. It is also possible to replace the stored sha with an empty string to set the review-status to false.

[Jonas-Kirchhoff]

To ensure that the correct version of trudag (2025.7.23 or later) is used, and that all imports are working as expected, it is recommended to execute the scripts from within the virtual environment supplied with the project, only.

In case that the virtual environment does not automatically activate when the devcontainer is not activated, please excecute the script .devcontainer/post_create_script.sh.

[Jonas-Kirchhoff]

To add an SME-score for an item ITEM-NAME, please insert your score under the key "score" within ITEM-NAME.md. The names of the reviewers are currently unused; nonetheless, it is recommended by Codethink to use the Github handle of the reviewer.

The total SME-score of an item is the mean of the collected SME-scores. Please note that these scores do not automatically appear in the documentation, unless the review-status of the corresponding items and links is set to reviewed. In the file TSF/docs/concept.rst, you may find a table explaining the calculation of the final score of each item.