Expand README with comprehensive usage documentation#151
Merged
Conversation
Co-authored-by: rbnswartz <724704+rbnswartz@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update README with details about usage
Expand README with comprehensive usage documentation
Oct 31, 2025
Member
|
@copilot No need to go into details about all the different types of markers |
Co-authored-by: rbnswartz <724704+rbnswartz@users.noreply.github.com>
Contributor
Author
Member
|
@copilot README.md:286 Don't need this section about error handling |
Co-authored-by: rbnswartz <724704+rbnswartz@users.noreply.github.com>
Contributor
Author
Removed the Error Handling section. Also addressed other feedback: removed "Lazy Processing" tip, added installation instructions, enhanced Building/Contributing sections, added performance tip for batch hierarchy queries, and moved shortened practical examples to the end. (bd225c4) |
rbnswartz
approved these changes
Nov 3, 2025
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.
The README lacked practical usage examples beyond basic parser instantiation and document creation.
Added Documentation
Installation
Building from Source
Contributing
Quick Start
Core Classes
Performance Tips
GetHierachyToMultipleMarkers()instead of loopingPractical Examples (End of File)
Example
All code examples validated against actual implementation.
Original prompt
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.