Add comprehensive file storage documentation for ioBroker adapters #620
+126
−1
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR addresses the integration of detailed file storage documentation for ioBroker adapter developers. The documentation explains the proper use of
writeFileAsyncwith meta objects and their impact on backup behavior.What's Added
New Documentation File
docs/en/dev/filestorage.md- Comprehensive guide covering:metavsmeta.user) and their backup behaviorIntegration Points
The documentation is strategically linked from two key locations where developers naturally look for file operation information:
Adapter Development FAQ (
docs/en/dev/adapter-dev-faq.md)Adapter Development Guide (
docs/en/dev/adapterdev.md)writeFilefunction listingwriteFileAsyncusageProblem Solved
Previously, developers encountered warnings like:
The new documentation provides clear guidance on:
meta(temporary, not backed up) vsmeta.user(persistent, backed up)io-package.jsonThis ensures developers can implement file storage correctly from the start and understand the implications for backup systems.
Original prompt