Skip to content

Fix(knowledge-card): Correct Word export format and sanitize filename

Edouard Legoupil requested to merge fix-knowledge-card-export into main_dev

Created by: Edouard-Legoupil

This commit fixes the Word export functionality for knowledge cards.

The previous implementation used a generic document creation function that incorrectly titled the document as a "Draft Project Proposal" and included a "Project Prompt Details" table. Additionally, the filename was not sanitized, which could lead to issues with special characters.

This has been resolved by:

  • Creating a new, dedicated function create_word_from_knowledge_card in backend/utils/doc_export.py.

  • This new function correctly formats the title as "Knowledge Card: [Card Name]" and excludes the "Project Prompt Details" table.

  • Updating the generate_and_download_document function in backend/api/knowledge.py to use this new function.

  • Using the slugify function to sanitize the filename of the exported Word document.

  • 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