Skip to content

Feature: enhanced README documentation for better project reading#27

Merged
simasgrilo merged 1 commit into
mainfrom
feature/readme-enhancement
Jun 2, 2025
Merged

Feature: enhanced README documentation for better project reading#27
simasgrilo merged 1 commit into
mainfrom
feature/readme-enhancement

Conversation

@simasgrilo

Copy link
Copy Markdown
Owner

Tl;dr

README rewriting to better display the project

Context

This change adds more context to what exaclty the project does, as well as the dependencies and how the architecture is done. I have added the following sections:

  • Stack used: all main components and their versions.
  • Architecture: the high level design on how the log aggregator works in a Kubernetes-first environment.
  • Features: Adds a bullet-list of features that the current solution has
  • Getting Started: step-by-step on how to run locally in a Kubernetes cluster.

Test Plan

N/A

Links

N/A

Checklist

  • Pull request title is succinct with [tiny] if it’s extra small
  • Describes the problem
  • Describes the solution (screenshots included if UI changes)
  • Has a test plan
  • Contains links to any context (Slack, Figma, JIRA ticket, etc.)
  • Code is self reviewed for readability, approach, and edge cases
  • Lines changed that may require additional explanation are annotated with an explanation
  • Change is ideally < 500 lines if possible. < 150 is ideal.

@simasgrilo

Copy link
Copy Markdown
Owner Author

Approved - no code changes, only documentation as aligned externally.

@simasgrilo simasgrilo merged commit 558e4ee into main Jun 2, 2025
2 checks passed
@simasgrilo simasgrilo deleted the feature/readme-enhancement branch June 2, 2025 00:30
@simasgrilo simasgrilo restored the feature/readme-enhancement branch June 2, 2025 00:35
This was referenced Jun 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant