docs: add a copy-paste prompt for new project to Slack - #14
Open
jerelvelarde wants to merge 3 commits into
Open
Conversation
The README's coding-agent prompt assumes a project already exists. The common first-time case does not: a developer wants a CopilotKit app and a working Slack channel, starting from nothing. Add a prompt covering that path end to end. It names the three skills to read, pins every CLI call to npx copilotkit@latest, makes the agent declare whether it can drive a browser before touching a live account, keeps secrets out of the chat, and holds success to the three gates in setup-slack-channel.
Most people land here to do exactly this, so the prompt should not sit below the install commands and a troubleshooting note. Promote it to the top of Build your first Channel under a 'Start with a prompt' heading, and link that heading from the header nav. Promoting it made the old 'Fastest path for Slack' block redundant -- both pitched installing skills and letting the agent drive -- so the two are merged into one section. Installing every skill now leads, since the prompt reads three of them and the Slack-only install would leave it short. The manual walkthrough keeps its framing under a new 'Or set it up by hand' heading.
Three code blocks and a troubleshooting callout stood between 'Start with a prompt' and the actual prompt, so the thing people came for sat below a screenful of setup. Keep one install command above it -- the prompt reads the skills, and skipping it costs a round trip -- and move the narrower --skill variant and the stale-CLI note below the prompt, where they are reference rather than a gate.
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.
Follow-up to #12 and #13, which made the skills install the default path for Slack. This adds the prompt a developer pastes after that install, and makes it the first thing in the section.
Why
The README already has a coding-agent prompt, but it assumes a project exists — it adds a Channels listener to code you already have. The common first-time case does not: someone wants a CopilotKit app and a working Slack channel, starting from nothing. Nothing covered that path.
The new prompt covers it end to end, and is deliberately defensive about the ways this setup goes wrong:
copilotkit-setup,copilotkit-channels,setup-slack-channel) and tells the agent to stop rather than improvise if any is missing.npx copilotkit@latest— the same stale-CLI failure docs: pin the skills install to copilotkit@latest #13 fixed.setup-slack-channel, so "the runtime started" cannot be reported as done.Placement
The prompt leads "Build your first Channel" under a Start with a prompt heading, linked from the header nav alongside Try Channels / Build with the SDK / Explore OpenTag. Most people arrive to do exactly this, so it should not sit below install commands and a troubleshooting note.
Promoting it made the previous "Fastest path for Slack" block redundant — both pitched install the skills, let the agent drive. The two are merged into one section rather than left as competing pitches.
One correctness change fell out of that merge: installing every skill now leads, with
--skill setup-slack-channelas the narrower option. The prompt reads three skills, so the Slack-only install would have left it a skill short — the previous ordering pointed most readers at the wrong command for the prompt sitting right under it.The manual walkthrough keeps its framing under a new Or set it up by hand heading. The prompt body stays in a collapsed
<details>— it is ~35 lines and would otherwise push the numbered steps well below the fold.Verification
npx copilotkit@latest --helplistscreate(an alias ofinit), so the scaffold command in the prompt is real.copilotkit skills install --listshows all three skill names the prompt references.#start-with-a-prompt,#build-your-first-channel,#see-a-complete-channels-appall resolve.[prompt below](#build-it-with-your-coding-agent). GitHub only generates anchors for real headings, not<summary>text, so that link would have shipped broken — it is now a plain textual reference. The new nav link targets a real###heading for this reason.One inconsistency to flag, not fixed here
The prompt gates on Node.js 20 or newer. Step 1 of this same README says Node.js 22 or later. An agent following the prompt could greenlight Node 20 and then hit an SDK that wants 22.
Left as written since the prompt text came in verbatim, but one of the two numbers is wrong and they are now closer together on the page. Happy to align them here — say which is authoritative.
Docs-only diff — no code, no tooling at the repo root, nothing to run.