docs(AppData): Tell the User about the LinkBase Property we use in Chefs App csproj files #1688
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the documentation for the AppData section by adding detailed guidance on using the LinkBase property in MSBuild Content elements for Uno Platform projects. The changes explain how to better organize data files in multi-project solutions while keeping them visible and editable in the Solution Explorer.
Key changes:
- Enhanced explanation of
CopyToOutputDirectoryproperty usage - Detailed documentation of the
LinkBaseproperty and its benefits - Added visual tree diagram showing how linked files appear in Solution Explorer
|
@kazo0 I noticed that the sample uses The only difference I’m aware of is that the Windows API exposes Roaming/Local/LocalLow folders. I might be mistaken, but my understanding is that A short note explaining the choice could help readers decide which option to use. Would it make sense to add that? PS: I added brief Information for the Consumer, about the availability of Storage Extensions since the Result seems to be the same |
…p Serialized AppData Files in Sync across multiple Projects in the Solution When working with Serialized AppData Files in Uno Projects, it's common to face challenges in keeping this shared App Data synchronized across multiple projects within the same solution. A practical approach to address this issue is by utilizing the LinkBase Property, similar to the method employed in Chef's App. For Users which are not familiar with this Property, this commit provides: - A detailed explanation of the LinkBase Property and its purpose. - A code snippet demonstrating how to set up the LinkBase Property in a project file. - A markdown diagram illustrating how this linked folder will show up in the Solution Explorer. - Link to the Chefs App csproj, so the User will then also be able, to learn from the Chefs App Sample implementation. This review was Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Steve Bilogan <steve.bilogan@gmail.com>
…S Docs link as requested
…ature for completeness and add Link to appropriate related docs
… using Storage Extensions from Uno
DevTKSS
force-pushed
the
improve-AppData-docs
branch
from
9994642 to
6c80f5f
Compare
2 participants
GitHub Issue (If applicable): #1661
PR Type
What kind of change does this PR introduce?
What is the current behavior?
Just setting the Property of Content, but without the two others the Chefs App uses its hard to understand the Enhancement to evaluate for our Projects and Solution that this can provide to us, against from using Resource Element for this for example.
What is the new behavior?
It's a great to know detail, that this will make those Files and even more Folders showing up in your Solution Explorer and keep those in sync! I would like to have this included and tell the User about this option.
Also added a small Tree View diagram to help more Visual thinking People like me get a better idea of the Endresult this will provide 🚀
PR Checklist
Please check if your PR fulfills the following requirements:
Screenshots Compare Test Runresults.With those Information, it gets more clearer to me, what this is doing and what the difference is, we are getting.
Other information
I would still be interested to know, why we do not use ContentSource via IOptions for this instead of that StorageFile way to do which seems to be a Windows Specifics🤔 maybe because of the Details added on this issue?
Maybe someone could check and improve this in any point in the future 💡
Internal Issue (If applicable):