-
Notifications
You must be signed in to change notification settings - Fork 59
docs(Storage): Improve Getting Started and Overview #2824
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
docs(Storage): Improve Getting Started and Overview #2824
Conversation
0b1569f to
911c67f
Compare
|
|
|
|
Contains Storage specific Guidance and Information to see the specific use cases
Co-authored-by: Steve Bilogan <[email protected]>
1048269 to
3e608cf
Compare
…arted-and-Overview
|
@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 |
…arted-and-Overview
…arted-and-Overview
…arted-and-Overview
There was a problem hiding this 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.
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
…arted-and-Overview
… the Templates just adding this unrequiredly Co-authored-by: Copilot <[email protected]>
|
Fun fact, while the docs are tellin us, we require |
GitHub Issue (If applicable): closes #2630
PR Type
What kind of change does this PR introduce?
What is the current behavior?
What is the new behavior?
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):