docs: restyle README header to match Channels SDK and OpenTag - #375
Open
jerelvelarde wants to merge 1 commit into
Open
docs: restyle README header to match Channels SDK and OpenTag#375jerelvelarde wants to merge 1 commit into
jerelvelarde wants to merge 1 commit into
Conversation
Adopt the shared CopilotKit repo header shape: a centered block with the title, a bold one-line positioning statement, a nav row, and stacked badges, followed by the demo video and a centered caption. - Move badges out of the H1 onto their own lines; label the npm badge @copilotkit/aimock and add the MIT license badge for parity - Add nav links to Quick start, The suite, Record & replay, and Docs - Rework the provider enumeration into the video caption so the keywords survive the tighter hero line
commit: |
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
1 participant
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.
What
Brings the aimock README header in line with the shared CopilotKit repo header shape used by channels-sdk and OpenTag.
The pattern those two share: a centered block holding the title, a bold one-line positioning statement, a nav row of key links, and stacked badges — then the demo video, then a centered caption.
Changes
# aimock, which made the title line wrap awkwardly. Now stacked on their own lines inside the centered block.@copilotkit/aimock, matching channels-sdk's treatment.## Quick Start,## The aimock Suite).No hero banner image was added —
docs/og-image.pngalready contains the wordmark and tagline, so it would duplicate the H1. OpenTag has no banner either; the demo video carries the visual.Verification
Docs-only change, but ran the full pre-commit suite from CLAUDE.md:
pnpm run format:check— cleanpnpm run lint— cleanpnpm run test— 176 files passed, 5234 tests passed, 46 skipped