Repository navigation
Send OpenDots readers to OpenBot from the top of the README - #195
Draft
jerelvelarde wants to merge 1 commit into
Draft
jerelvelarde wants to merge 1 commit into
jerelvelarde wants to merge 1 commit into
Conversation
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
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.
main)The problem
OpenDots has shipped as a skin in OpenBot since early November, and the README says so, but that sentence sits below the badges, the Trendshift badge and the hosting paragraph. Above it, the only sign of OpenBot is a small "also a skin in OpenBot" badge. Every OpenBot link in the file goes to GitHub, and none goes to open.bot, which became OpenBot's official home after this README was last edited.
So a reader can get through the whole first screen without learning that a maintained version of the same interface exists, and open.bot gets no links from a repository with 6.7k stars.
The approach
The existing lead line, "OpenDots is now available as a UX skin in OpenBot", moves up to sit directly under the tagline. Its wording is unchanged, and "OpenBot" in it now links to open.bot. Under it are two buttons in OpenBot's own colors: one to open.bot, and one to the OpenBot repository showing its live star count. The line is moved rather than repeated, so the README still says it once.
The links follow one rule. Where a reader is being sent to try or learn about OpenBot, the link is open.bot: the badge, the skin screenshot, and the first mention in "OpenDots and OpenBot". Where a reader is being sent to code or setup steps, the link stays on GitHub: the quick-start row in that section's table, the "code references" line, and the References list. Two of those GitHub links used a lowercase
CopilotKit/openbotURL and now use the repository's real casing.Every badge and call to action that was on the page before is still there, in the same order.
What is not covered
Verification
prettier --check README.mdpasses. CI'scheck-formatcovers README.md.mainat 0e706ab, after is this branch.app/src/skins/skin-picker.tsx), andapp/src/skins/opendotsships in OpenBot v1.1.1.Merge notes
#191 renames the old project name to OpenFuse on two lines this PR also edits, so the two conflict. Main already has that rename, so #191 can likely close. If it merges first, this branch needs a small rebase.