Draft: Resolve "Update Docs to F13 Standard"

Lisa Gölzrequested to merge
44-update-docs-to-f13-standard into main

What is new and why?

  • docs Folder angelegt
  • Aktuelles README angepasst
  • Spezifische Docs in eigenem Subfolder angelegt
  • Spellechek
  • Folgetickets erstellt für nötige Anpassungen
  • Aktualität der Dokumentation im Review prüfen

Related issues

Notwendige Anpassungen für die Doku: Env Variables to Secrets (#24),Modify API schemas of Endpoints to pass schemat... (#58), Dev- & Test-Container zum laufen bringen (#60)

Equivalentes Ticket im Backend: inference#36

Author's TODOs

  • merged latest version of target branch (e.g., main or dev) into your branch
  • check if SPDX identifier MPL-2.0 and Copyright-Text 2025 Land Baden-Württemberg <InnoLab@stm.bwl.de> exists in newly created and/or hasn't been deleted somehow in existing files
  • adapted the readme
  • Revised/new code parts have no # noqa directives
  • Optional: Changelog adapted (further information)

Reviewer's TODOs

  • Check if the Author did their checks well enough
  • Tried out if the cause of the issue is solved as intended
  • Check that code with old # noqa directives were revised
  • Check that no new # noqa directives are included
  • Optional: Changelog adapted (further information)

To keep in mind

  • pre-commit used
  • added logging output were necessary
  • added/adjusted Errorhandling to avoid unwanted crashes and make proper debugging and testing possible
  • Changelog has to be adapted before merging, at latest in the f13::inAbnahme step

Closes #44

Edited by Lisa Gölz

Merge request reports