Create overview.md #5386
Closed
Create overview.md #5386
Conversation
This file contains 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
This is an AI generated code review using GPT-4o model from [cursor](https://www.cursor.com/). I think we can add this, I see 2 benefits 1) Very high level overview for any new contributor to understand the codebase of query service (we don't even have structured code nor comments, this is not needed for us but would be needed for external collaborators) 2) Contributors can add more fine details like, the API documentation (in readme), the flow, etc etc
Create overview.md
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.
This is an AI generated code review using GPT-4o model from cursor. I think we can add this, I see 2 benefits
Preview https://github.com/SigNoz/signoz/blob/02e4be4902b8906d57087af7b9604d03bdf67457/pkg/query-service/overview.md