Skip to content

docs: add an About section framing OpenTag as a Channels SDK starter - #39

Merged
jerelvelarde merged 2 commits into
mainfrom
jerel/channels-sdk-about-section-a84134
Aug 12, 2026
Merged

docs: add an About section framing OpenTag as a Channels SDK starter#39
jerelvelarde merged 2 commits into
mainfrom
jerel/channels-sdk-about-section-a84134

Conversation

@jerelvelarde

@jerelvelarde jerelvelarde commented Aug 12, 2026

Copy link
Copy Markdown
Collaborator

The README explains what OpenTag does and how to fork it, but never says who
publishes it, that it exists as a starter project for the Channels SDK, or where
to go with a question. This adds an About section above the license.

What it says

  • CopilotKit builds and maintains it — the team behind the Channels SDK and
    AG-UI.
  • OpenTag is a starter project for the Channels SDK: the SDK README shows the
    pieces on their own, OpenTag is those pieces assembled and deployable,
    published so a fork starts from a working system. Kept aligned with the SDK so
    forks stay upgradeable.
  • Restates the one distinction the rest of the README already warns is easy to
    confuse: @copilotkit/channels is the open-source library; CopilotKit
    Intelligence is the optional managed connection.
  • Where to reach us: Discord, @CopilotKit on X, docs, and separate issue
    trackers for the app vs. the SDK.

Link provenance

No invented URLs. The Discord invite and X handle are the ones in
CopilotKit/CopilotKit's README; the copilotkit.ai, AG-UI, and Channels SDK
links are the ones channels-sdk's README publishes.

Not included, deliberately

  • No Contributing line — the repo has no CONTRIBUTING.md, so forks are pointed
    at issues instead.
  • No security-reporting line — docs: add security reporting guidance #5 is already open for that.
  • Also renames the section heading above from "The complete Channels SDK
    application" to "The Channels SDK starter application" — the two framings
    contradicted each other, and starter is the accurate one. Nothing linked to
    the old anchor.
  • Header nav (line 7) left unchanged; adding About to it is a one-liner if
    reviewers want it.

README-only, no code paths touched.

The README explains what OpenTag does and how to fork it, but never says who
publishes it, that it exists as a starter project for the Channels SDK, or
where to go with a question.

Add an About section above the license that says all three, and restate the
one distinction the rest of the README warns is easy to confuse: the
open-source Channels SDK is the library, CopilotKit Intelligence is the
optional managed connection. Community and issue links match the ones the
CopilotKit and channels-sdk READMEs already publish.
The new About section frames OpenTag as a starter project for the Channels SDK,
while the section heading above still called it the complete Channels SDK
application. Two claims about the same repository, and the starter framing is
the accurate one: OpenTag is a working system you fork, not a finished product.

Nothing linked to the old anchor.
@jerelvelarde
jerelvelarde marked this pull request as ready for review August 12, 2026 12:06
@jerelvelarde
jerelvelarde merged commit 6e1e949 into main Aug 12, 2026
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