Adnan/update docs - #21
Merged
Merged
Conversation
adnan-kamili
requested review from
Copilot,
fazelshah,
mohammad-anees-khan and
saalim-mushtaq
July 14, 2026 06:37
There was a problem hiding this comment.
Pull request overview
Updates the on-premise documentation and configuration templates to reflect the current single-server Docker Compose architecture, moving key guidance into the root README and removing older standalone docs.
Changes:
- Reworked
README.mdto include architecture, installation, updating, and OpenTelemetry monitoring guidance. - Updated
web-api.envto document OpenTelemetry-related environment variables (and removed older commented provider keys). - Removed legacy docs pages and an unused GitHub Actions workflow; added a minimal
.gitignore.
Reviewed changes
Copilot reviewed 8 out of 14 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
web-api.env |
Updates observability-related env var template for OpenTelemetry/New Relic. |
README.md |
Consolidates architecture + install + monitoring docs into the main README. |
docs/030-monitoring-your-instance.md |
Removed (content moved/covered in README). |
docs/025-configuring-client-libraries.md |
Removed (content moved/covered in README). |
docs/020-Installation-Guide/0200-docker.md |
Removed (superseded by README installation steps). |
docs/010-system-requirements.md |
Removed (requirements now described in README). |
docs/000-overview.md |
Removed (overview now described in README). |
.gitignore |
Added ignore rule for .DS_Store. |
.github/workflows/codium_pr_agent.yml |
Removed Codium PR Agent workflow. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
mohammad-anees-khan
approved these changes
Jul 14, 2026
mohammad-anees-khan
left a comment
mohammad-anees-khan
left a comment
Collaborator
There was a problem hiding this comment.
Looks good to me
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.