Update bookmarks.md #712
Open
Update bookmarks.md #712
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Refactor: Enhance Bookmarks Documentation
This pull request significantly improves and expands the documentation for the bookmarks feature in Avalonia's StorageProvider. The goal is to provide a more comprehensive and practical guide for developers.
Key Changes:
Detailed Interface Description: The document now includes a detailed breakdown of the IStorageBookmarkItem interface, listing its properties and methods.
Structured Usage Guide: The "How to Use" section has been completely rewritten into a structured guide with clear sub-sections for "Saving and Loading" and "Managing" bookmarks.
Practical Code Examples: Full C# code snippets are provided for key methods like SaveBookmarkAsync, OpenFolderBookmarkAsync, and ReleaseBookmarkAsync, offering a clear, hands-on understanding.
Platform-Specific Information: A new section explains how bookmark IDs are represented differently across various platforms, such as Windows and Android.
These updates make the documentation more informative and user-friendly, giving developers the necessary tools and examples to correctly implement bookmark functionality.