docs: clarify introductory guides with practical examples - #1242
johnslavik wants to merge 1 commit into
Conversation
Replace promotional phrasing and repeated assurances with reference-style explanations and concrete first-run examples. Generated-by: GitHub Copilot CLI 1.0.83 (GPT-6 Astra) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
sjyangkevin
left a comment
sjyangkevin
left a comment
There was a problem hiding this comment.
also following the guide, and would like to propose some small feedback. thanks!
| Add the marketplace and install plugins at user scope. | ||
| This step does not write to the repository. | ||
|
|
||
|  |
There was a problem hiding this comment.
The animation looks cool, but I feel a little hard to follow. I was trying to run the command one by one in step 1 to have basic setup for Claude Code. Especially, when trying to follow the second and the third commands, typing it half-way, and then it disappears, need to wait for it to show up again. Just from my perspective, maybe a code block that can be copied would be better 🤔 , just like those in step 2 and step 3.
There was a problem hiding this comment.
It's very hard to follow.
Making it copy-pastable is on my list.
There was a problem hiding this comment.
FYI. I am working on being able to previiew site + docs straight from PRs . magpie-site first - then mapgie docs
There was a problem hiding this comment.
3 participants
Make the README and onboarding guides easier to use as reference documentation. Replace promotional phrasing and repetition with direct explanations, practical examples, and expected outcomes while preserving illustrations and workflow safeguards.
Documentation only; no skill or runtime changes.
AI assistance: GitHub Copilot helped draft these edits.