Skip to content

docs: Update backend and scripts READMEs

Edouard Legoupil requested to merge feature-populate-db-from-excel into main_dev

Created by: Edouard-Legoupil

Updates the main backend/README.md to include a new "Scripts" section, providing an overview of the available command-line utilities.

Revises the backend/scripts/README.md to reflect the latest changes to the scripts:

  • Documents the switch to an Excel file for the populate_knowledge_cards.py script.

  • Adds a new section for generate_card_content.py, detailing its content generation and file-saving functionality.

  • Updates the descriptions for all scripts to mention the new logging system.

  • Does my code meet the quality standards for releasing packages?

  • Does the reviewer have all the information to validate the features/issues without too much research?

  • Does the customer who will validate the associated tickets have the information to do so without wasting time?

Issues to validate to close :

  • issue #

Processed issues to keep open or in progress:

  • issue #

Checklist:

  • Does the package check go local?
  • Does the CI pass?
  • Are the added / fixed features documented, tested?
  • Are the added features / solved problems briefly presented in the PR message?
  • Are the changes related to tickets / issues that I have listed in the commits and in the PR itself?
  • Are the tickets in "review" mode in the Project Tracking Board?
  • Does each ticket, if it is to be closed after acceptance of the PR, contain a comment that tells how to validate it?

Merge request reports