Skip to content

docs: align README and contributing guide with the sibling plugins - #101

Merged
hassiebp merged 3 commits into
mainfrom
worktree-readme-alignment
Sep 23, 2026
Merged

hassiebp merged 3 commits into
mainfrom
worktree-readme-alignment

Conversation

@milanagm

@milanagm milanagm commented Sep 23, 2026 •

Copy link
Copy Markdown
Contributor

Aligns the README with the sibling observability plugins for opencode and Claude Code, in structure and in information density (19 KB down to 3.7 KB).

  • README follows opencode's sections: Quick Start, Supported Versions, Langfuse Credentials, Contributing, License.
  • Adds CONTRIBUTING.md adapted from opencode's, keeping the Codex specifics that both manifest versions have to be bumped and that .agents/plugins/marketplace.json has to be repointed after a release.
  • Links the Langfuse Codex integration page.

@claude claude Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good — a docs-only restructuring that's accurate. Checked the new CONTRIBUTING.md commands (build/test/format/lint) against the actual package.json scripts — they match. Verified the referenced paths (plugins/tracing/package.json, plugins/tracing/.codex-plugin/plugin.json, .agents/plugins/marketplace.json) exist. The condensed README content (versions, env resolution order, regions) is consistent with the detail it replaced.

Extended reasoning...

This PR only touches README.md and CONTRIBUTING.md (no code, config, or security-sensitive surface). It condenses README content into a new CONTRIBUTING.md and a shorter README, and I cross-checked the new build/test/lint commands against package.json scripts and the referenced file paths (package.json, plugin.json, marketplace.json), all of which exist and match. The change is mechanical documentation restructuring with no ambiguity or design decisions requiring human input.

@milanagm
milanagm requested a review from hassiebp September 23, 2026 12:36
@hassiebp
hassiebp merged commit 4c18beb into main Sep 23, 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.

2 participants