docs: clarify cards and workspaces for newcomers - #75
Open
felipeofdev-ai wants to merge 1 commit into
Open
Conversation
Explain what a card is before the setup section, and note that the overview gif is intentionally fast. Fixes nubank#38 Signed-off-by: Felipe Fernandes <felipe.of.dev@gmail.com>
There was a problem hiding this comment.
Pull request overview
This PR improves the project’s onboarding documentation by adding a short conceptual introduction to Workspaces and explicitly defining what a “card” is before the setup instructions.
Changes:
- Rewrites the opening README description to explain cards/workspaces and the “develop in isolation” workflow.
- Adds a “What is a card?” section describing typical card usage (components and
cljs.testoutput). - Adds a TIP clarifying that the overview GIF is intentionally fast.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| in tabs called *workspaces*, and resize or reposition them — without | ||
| booting your entire application or switching to a terminal for test output. | ||
|
|
||
| === What is a card? |
|
|
||
| === What is a card? | ||
|
|
||
| A *card* is one isolated demo unit. Typical cards render a single UI |
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.
Summary
Why
Issue #38 asked for a brief conceptual intro (and card definition) before setup, plus acknowledgement that the GIF is hard to follow at full speed.
Fixes #38
Test plan
— Felipe Fernandes · Systems & Agentic AI Engineer
https://github.com/felipeofdev-ai · https://felipeofdev-ai.github.io/