docs: cleanup readme formatting + update FAQ #8
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
There was a problem hiding this comment.
Pull request overview
This PR cleans up README formatting by consolidating multi-line text blocks into single lines for better readability and updates the FAQ section with more precise questions and answers. The changes improve documentation clarity without altering functionality.
- Reformatted text blocks to single lines for consistency
- Updated FAQ with more specific questions ("What filters are supported?" instead of "Can I filter logs by site, user, or context?")
- Fixed GitHub repository link from internal to public repository
- Reorganized troubleshooting section and moved license information to its own section
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
patil-vipul
approved these changes
Dec 17, 2025
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.
What
Why
Related Issue(s):
How
Testing Instructions
Screenshots
Additional Info
Checklist