Repository navigation
docs(documents): record that deleting an artifact document removes its files - #2015
Conversation
…s files PR #1934 fixed the code and deleted the Known gap line in studio.md, but documents.md carried the same gap plus a prose bullet asserting the old behaviour. Both were false on dev. Co-authored-by: Cursor <cursoragent@cursor.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Advanced Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
What
Finishes the doc side of #1934 in
docs/architecture/documents.md:ARTIFACTdocument leaves its files underartifacts/<id>/.documents/<id>/, so the artifact's files underartifacts/<id>/stay on disk".Why
The same gap was written down in two docs. #1934 fixed the code and deleted the line in
docs/architecture/studio.md, butdocuments.mdcarried its own copy and kept it, along with a prose sentence asserting the old behaviour. Both are now false ondev.delete_document()insurfsense_local/backend/modules/documents/router.pybuilds a list of directories and appendsstorage.artifact_dir(...)whendocument.artifact is not None, then removes each after the commit:studio.mdneeds nothing further: its remaining sentence aboutDELETE /artifacts/{id}was always about the artifact route and is still accurate.This is worth catching rather than leaving:
CONTRIBUTING.mdand the READMEs send contributors to the Known gaps lists to find work, so the surviving line advertises a fixed bug as an open task. It was deliberately not filed as an issue in the recent batch precisely because #1934 was expected to close it.Fixes #
How to test
96 doc files, 0 problems. Docs only, no code touched. The behaviour the new wording describes is covered by the integration test #1934 added in
surfsense_local/backend/tests/integration/artifacts/test_routes.py.High-level PR Summary
This PR updates the documentation in
documents.mdto accurately reflect that deleting anARTIFACTdocument now removes both the document files underdocuments/<id>/and the artifact files underartifacts/<id>/. The changes remove an outdated Known gaps entry and correct a prose description that still claimed the old behavior where artifact files would remain on disk after deletion. These documentation updates align with the code changes from PR #1934 that fixed this behavior.⏱️ Estimated Review Time: 5-15 minutes
💡 Review Order Suggestion
docs/architecture/documents.md