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

Docs(Storage): Improve and add Storage Documentation and Reference #2710

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

DevTKSS
Copy link

@DevTKSS DevTKSS commented Mar 7, 2025

GitHub Issue (If applicable): closes #2630

Please do NOT auto close this PR while:

  • tasks of the list are still open, which are telling about content to be added
  • any of them has TODO marks to ensure checkup of Links are outstanding

PR Type

What kind of change does this PR introduce?

  • Documentation content added
  • Bugfix

What is the current behavior?

  1. We are missing almost whole Uno.Extensions.Storage Documentation currently as you can check here, so its unclear how the code acts without researching repository src and how it should be implemented just taking the documentation into consideration
  2. Bugfix: The Navigation Reference Overview Page has been not shown in the Side navigation and was only reachable throught clicking directly on the parent NavigationItem

What is the new behavior?

Sidenote

Tryed to use the notes as suggestion and also as way to request specifyed check-ups, but keep the task list clean

Planned and done Updates of this Documentation as Task List:

  • 1. Add Storage related Links to the Overview Page
    • 1.1. Add links to already existing documentation pages
      • 1.1.1. Research Uno.UI.Tookit: Added StorageFileHelper as Link
      • 1.1.2. Research Reference Non-UI: Added links to File and Folder Pickers and Settings
    • 1.2. Add Links to the new added Storage Reference
      • 1.2.1. Add Link to the Overview as good starting point for a lookup => TODO: Checks outstanding
      • 1.2.2. Add Link to nested Storage Pages already included in the commits so far => TODO: Checks outstanding
      • 1.2.3. Add other public Storage topics in the code base
  • 2. Add Reference Pages
    • 2.1. Add Reference Content Pages
      • 2.1.1 Try to use DocFx common functionallity of using the regular xml documentation of the actual codebase !Failed!
      • 2.1.2 Fallback: Add them manually similar to Navigation Reference because there is no Reference documentation template available
      • 2.1.3 Check the markdown to be correctly shown with local serve !Failed! Read Note information for this
    • 2.2. Add Reference Overview Page for Storage
      • 2.2.1. Added Overview and included a table which lists all nested pages
      • 2.2.2. Check the links in the table to actually work
  • 3. Add Sample(s) WITH Tutorial / How-To

Note

Tryed along this failing and the Readme in extensions repo but at running the Run of the powershell cmd it seems to not know my branch... hoping this will run and be checkable after adding this PR, but it would be better if it would be able to check the docs before

PR Checklist

Please check if your PR fulfills the following requirements:

  • Tested code with current supported SDKs => Failed, unable to serve locally, is this required for docs?
  • Docs have been added/updated which fit documentation template. (for bug fixes / features)
  • Docs have been added/updated which fit documentation template !Missing template for Reference!
  • Unit Tests and/or UI Tests for the changes have been added (for bug fixes / features) (if applicable)
  • Wasm UI Tests are not showing unexpected any differences. Validate PR Screenshots Compare Test Run results.
  • Contains NO breaking changes => Its documentation... so no? just 'big' improvements planned 😄
  • Updated the Release Notes => would say not needed for docs isnt it? Should I add something for this in Release Notes?
  • Associated with an issue (GitHub or internal) Storage not documented #2630

Other information

Warning

We don't have any DocFx.json at the Repository Root or the src folder root which would enable using codebases generated xml, onlyone is at the docs root. So by Generating Reference manually is preset to be not up to date if anything is changed and also incomplete

Tip

Evaluate this capability to be added refering to https://github.com/unoplatform/uno/blob/master/doc/api/index.md also to the extensions repository?

Help Welcome!

If any of you out here, maybe also documentation expirienced ones, but that's not a must-have, you want to join this PR?

These tasks, beside the above listed ones, you could actually tackle:

  • Feedback and improvement suggestions to the created docs Content in general, but also on the Reference markdown styles
  • Include/Use the actual src xml documentation output with docfx @nickrandolph Reading the Commit Message on the storage repo files it seems like you did the xml documentation, maybe you could check if you could help out including those for the reference documentation?
  • One or more Tutorials would be great to have! @kazo0 send a simple sample app for this topic in this Discussion which could be used as starting point and by adding e.g. JsonSerializer with a Record similar to the Peoples App in Mvux but with the usage of Configuration and Options setup could be better. Possible that JsonSerializer is not capable of Immutable types, so a setup similar to the wizard created AppConfig Record should maybe prefered for this.

DevTKSS added 3 commits March 5, 2025 21:19
To be checked: The markdown formatting used for the paramrefs of the listed functions might be incorrect but since the actual xml of the project in src folder seems not to be readed at all, this formatting is all I got so far. Possible that I will have to edit this commit for this if a PR would not run throught on formatting checks
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
1 participant