Skip to content

docs: redesign README with architecture and exporter rationale#13

Merged
rokernel merged 1 commit intomasterfrom
docs/readme-redesign-exporter
Feb 25, 2026
Merged

docs: redesign README with architecture and exporter rationale#13
rokernel merged 1 commit intomasterfrom
docs/readme-redesign-exporter

Conversation

@rokernel
Copy link
Owner

Summary

  • Redesign the root README to be cleaner and more structured for first-time users.
  • Explain why exporters are useful in SONiC observability workflows and what this project solves.
  • Add architecture diagrams, a clearer collector matrix, and explicit upstream acknowledgments.
  • Add docs/architecture.md with a focused structural and runtime overview.

Validation

  • go test ./... passed.
  • go build ./... passed.
  • markdownlint is not installed in this environment, so markdown linting could not be executed.

@rokernel rokernel merged commit 2962a37 into master Feb 25, 2026
2 checks passed
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