Skip to content
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

Storage not documented #2630

Open
ygoe opened this issue Dec 1, 2024 · 2 comments
Open

Storage not documented #2630

ygoe opened this issue Dec 1, 2024 · 2 comments
Labels
kind/consumer-experience Categorizes issue or PR as related to improving the experience of consumers kind/documentation Categorizes an issue or PR as relevant to 3rd party dependencies that are consumed by this project

Comments

@ygoe
Copy link

ygoe commented Dec 1, 2024

On which page?

https://platform.uno/docs/articles/external/uno.extensions/doc/Learn/Storage/StorageOverview.html

What's wrong?

It speaks of a walkthrough but I see nothing. No tutorial, no API reference, no Google results. Does it even exist?

Any feedback?

Documentation is really an issue with Uno. I understand that it relies on WinUI3 and likes to refer to that documentation, but it deviates often enough that it's often unclear how things work. The Uno dev team knows it because they've written it but nobody else does. And this feature is even explicitly Uno-specific, so it absolutely needs an explanation.

I guess I'll start with normal File access and see how far I get on Android. Never worked with files in own apps there. All I know is that Android has a different opinion of using files than desktop OSs have.

@ygoe ygoe added kind/consumer-experience Categorizes issue or PR as related to improving the experience of consumers kind/documentation Categorizes an issue or PR as relevant to 3rd party dependencies that are consumed by this project triage/untriaged Indicates an issue requires triaging or verification. labels Dec 1, 2024
@DevTKSS
Copy link

DevTKSS commented Dec 9, 2024

Would also appreciate that to be documented! Would like to add: not only files access on Android / IOS, because their specification with the Entitlements is at least a bit documentated, but lets say we would like to "just" do CRUD operations on a Windows or Desktop target, I did not find any documentation for how to do that with uno at all... just like to consume data from there or save things the app is used for... Maybe its so basically no one of the team did think needed to be documentated or at least linked properly to the pages where we would find more information? Only Data I could consume with apps from the docs would be api web data or the configuration things, which not even containing things like where would we store things like secrets? in configuration? Dont think so! In other frameworks it is done with a dotenv-vault, but running in vs code is not for every app good...

@kazo0 kazo0 removed the triage/untriaged Indicates an issue requires triaging or verification. label Dec 15, 2024
@kazo0
Copy link
Contributor

kazo0 commented Dec 15, 2024

Thanks for the report @ygoe!

It indeed would be great to add more info to the Storage documentation

Along with this, it would be also beneficial to have a sample app created and pushed to the Uno.Samples repo that demonstrates usages

This has been added to the backlog, but, in the meantime, if anyone would like to contribute their time to further explain and make a PR for this, that would be very greatly appreciated!

If it helps, I have tried to add some more explanation on using Storage Extensions in this discussion.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/consumer-experience Categorizes issue or PR as related to improving the experience of consumers kind/documentation Categorizes an issue or PR as relevant to 3rd party dependencies that are consumed by this project
Projects
None yet
Development

No branches or pull requests

3 participants