added docs - #20
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR substantially expands the repository documentation by replacing the brief README with a fuller On‑premise overview and adding several new docs pages covering system requirements, Docker Compose installation, client library configuration, and monitoring.
Changes:
- Reworked
README.mdinto a more complete product/deployment overview with links to local docs. - Added new documentation pages for overview, system requirements, client SDK configuration, and monitoring.
- Added a Docker Compose installation guide under
docs/020-Installation-Guide/.
Reviewed changes
Copilot reviewed 6 out of 11 changed files in this pull request and generated 11 comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Expanded README content and added a docs navigation table (currently contains broken links/typos). |
| docs/000-overview.md | Added an overview page with a server layout diagram (minor naming consistency issue). |
| docs/010-system-requirements.md | Added system requirements documentation. |
| docs/020-Installation-Guide/0200-docker.md | Added Docker Compose installation/upgrade guide (contains multiple link/formatting issues). |
| docs/025-configuring-client-libraries.md | Added client library configuration instructions (terminology inconsistencies). |
| docs/030-monitoring-your-instance.md | Added a monitoring page describing OpenTelemetry integration. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Collaborator
Author
|
@adnan-kamili Resolved comments, please check |
fazelshah
approved these changes
Jun 24, 2026
saalim-mushtaq
approved these changes
Jun 24, 2026
|
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.
No description provided.