Skip to content

Conversation

@DevTKSS
Copy link
Contributor

@DevTKSS DevTKSS commented Jun 19, 2025

GitHub Issue (If applicable): closes #2630

PR Type

What kind of change does this PR introduce?

  • Documentation content changes

What is the current behavior?

  • Missing complete Getting Started Page for Storage Extensions, the existing one is very few and by that incomplete, not usable "as is"

What is the new behavior?

  • Improved Overview Page with more details about when to use Storage Extensions like file types
  • Mentioned additional Libraries for not directly serialization supporting storage files
  • Added a includes usable md file for future Storage How-To's to the Getting Started Guide.
  • Added a full Storage Getting Started Guide with Mvvm & Mvux specific VM setup code diff and specifics that will enable to set up the future storage files properties correctly "CopyToOutputDirectory"

PR Checklist

Please check if your PR fulfills the following requirements:

Other information

Thank's again to @kazo0 for support to get the setup correct!

The PR #2710 will be simplifyed to "just" add the mentioned samples in exchange to the not existing API Reference one sample usage per function. More detailed Guides after this should then be added to the Chefs Reciept book, but I would at this point not know that it is reading from assets => future appdata nested files similar to my MvuxGallery is doing.

Internal Issue (If applicable):

@DevTKSS DevTKSS force-pushed the docs(Storage)-Improve-Getting-Started-and-Overview branch from 0b1569f to 911c67f Compare June 19, 2025 16:50
@unodevops
Copy link
Contributor

⚠️⚠️ The build 169006 has failed on uno.extensions.

@unodevops
Copy link
Contributor

⚠️⚠️ The build 169030 has failed on uno.extensions.

DevTKSS and others added 2 commits June 21, 2025 14:32
Contains Storage specific Guidance and Information to see the specific use cases
Co-authored-by: Steve Bilogan <[email protected]>
@DevTKSS DevTKSS force-pushed the docs(Storage)-Improve-Getting-Started-and-Overview branch from 1048269 to 3e608cf Compare June 21, 2025 12:33
@DevTKSS
Copy link
Contributor Author

DevTKSS commented Jul 7, 2025

@kazo0 @Kunal22shah so from what I see in the src, up from we having a non blank Preset app, we would always have the Hosting inlcuded. But on the other hand, as this is already pulling in the .UseStorage() at the very end, it could be optional, to add the Storage Feature, but in my opinion, we should tell to do this either way like on all other Features.

Copilot AI review requested due to automatic review settings September 23, 2025 16:45
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR improves the Storage extension documentation by adding a comprehensive Getting Started guide and enhancing the existing overview. The changes provide developers with clear step-by-step instructions for setting up and using the Storage extension in their Uno Platform applications.

Key changes:

  • Added a complete Getting Started guide with setup instructions for both MVUX and MVVM patterns
  • Enhanced the Overview page with more details about file types and when to use Storage extensions
  • Created reusable documentation includes for prerequisites

Reviewed Changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
doc/Learn/includes/getting-help.md Added reference to Uno.Sdk documentation
doc/Learn/Storage/toc.yml Added Getting Started guide to navigation
doc/Learn/Storage/includes/use-storage-prerequisites.md Created reusable prerequisites include
doc/Learn/Storage/StorageOverview.md Enhanced overview with file type guidance and better structure
doc/Learn/Storage/Storage-GettingStarted.md Added comprehensive Getting Started guide
doc/ExtensionsOverview.md Added Storage extension to main extensions list
build/ci/cspell.json Added spell check entries for XML doc tags
build/ci/.markdownlint.json Disabled emphasis-as-heading rule

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@DevTKSS DevTKSS requested a review from kazo0 September 25, 2025 20:16
@DevTKSS
Copy link
Contributor Author

DevTKSS commented Dec 4, 2025

Fun fact, while the docs are tellin us, we require Hosting for DI, our app is fine at runtime without it 🤷 and yes, the app I used to test this with is using the DI Container for Keyed Services

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Storage not documented

3 participants