Redesign README for personal website using WebTUI#1
Open
saforem2 wants to merge 2 commits into
Open
Conversation
Updated README to reflect personal website redesign using WebTUI.
✅ Deploy Preview for sam4 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Reviewer's guide (collapsed on small PRs)Reviewer's GuideReplaces the library-focused README with a minimal personal website description pointing to sam.onl and referencing WebTUI. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey - I've found 1 issue, and left some high level feedback:
- The updated README replaces the WebTUI project documentation entirely with content about a personal website; consider either adding the personal site as a section while retaining core library info or moving this change to the personal site's repo instead.
- The new README text is very minimal and a bit unclear (e.g., “Personal website (redesign!) Using WebTUI”); consider expanding this into a brief but complete description (what the repo is, what WebTUI is, and how they relate) with consistent capitalization and punctuation.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- The updated README replaces the WebTUI project documentation entirely with content about a personal website; consider either adding the personal site as a section while retaining core library info or moving this change to the personal site's repo instead.
- The new README text is very minimal and a bit unclear (e.g., “Personal website (redesign!) Using WebTUI”); consider expanding this into a brief but complete description (what the repo is, what WebTUI is, and how they relate) with consistent capitalization and punctuation.
## Individual Comments
### Comment 1
<location> `README.md:3` </location>
<code_context>
- ```bash
- bun run dev
- ```
+Personal website (redesign!) Using [WebTUI](https://webtui.ironclad.sh)
</code_context>
<issue_to_address>
**suggestion (typo):** Consider lowercasing "Using" so the line reads as a single coherent phrase.
"Using" is mid-sentence here, so lowercasing it to `using` would make the description read more naturally: `Personal website (redesign!) using [WebTUI](...)`.
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
| ```bash | ||
| bun run dev | ||
| ``` | ||
| Personal website (redesign!) Using [WebTUI](https://webtui.ironclad.sh) |
There was a problem hiding this comment.
suggestion (typo): Consider lowercasing "Using" so the line reads as a single coherent phrase.
"Using" is mid-sentence here, so lowercasing it to using would make the description read more naturally: Personal website (redesign!) using [WebTUI](...).
There was a problem hiding this comment.
Pull request overview
Updates the repository’s top-level README to reference a personal website redesign built with WebTUI, rather than describing the WebTUI project itself.
Changes:
- Replaced the existing WebTUI root README content with a minimal personal-website description and link.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+1
to
+3
| # [sam.onl](https://sam.onl) | ||
|
|
||
| Modular CSS Library that brings the beauty of Terminal UIs to the browser | ||
|
|
||
| - Docs: https://webtui.ironclad.sh | ||
| - Examples: https://webtui.ironclad.sh/showcase | ||
| - Discord Server: https://discord.gg/yUS6T8YnfT | ||
|
|
||
| ## Quickstart | ||
|
|
||
| Install the base WebTUI package with your preferred package manager | ||
|
|
||
| ```bash | ||
| bun i @webtui/css | ||
| npm i @webtui/css | ||
| yarn add @webtui/css | ||
| pnpm install @webtui/css | ||
| ``` | ||
|
|
||
| In your global CSS file, define the order of layers then import the library | ||
|
|
||
| ```css | ||
| @layer base, utils, components; | ||
|
|
||
| @import '@webtui/css'; | ||
| ``` | ||
|
|
||
| Start using the library in your HTML | ||
|
|
||
| ```html | ||
| <button>click</button> | ||
| <button size-="large">click me too</button> | ||
| <div box-="square"> | ||
| <p>content</p> | ||
| </div> | ||
| ``` | ||
|
|
||
| For more detailed installation instructions, see the [installation guide](https://webtui.ironclad.sh/start/installation) and [framework-specific installations](https://webtui.ironclad.sh/start/installation) | ||
|
|
||
| ## Packages | ||
|
|
||
| All the officially-maintained packages in the monorepo | ||
|
|
||
| - [@webtui/css](https://npmjs.com/package/@webtui/css) | ||
| - [@webtui/plugin-nf](https://npmjs.com/package/@webtui/plugin-nf) | ||
| - [@webtui/theme-catppuccin](https://npmjs.com/package/@webtui/theme-catppuccin) | ||
| - [@webtui/theme-gruvbox](https://npmjs.com/package/@webtui/theme-gruvbox) | ||
| - [@webtui/theme-nord](https://npmjs.com/package/@webtui/theme-nord) | ||
| - [@webtui/theme-vitesse](https://npmjs.com/package/@webtui/theme-vitesse) | ||
| - [@webtui/theme-everforest](https://npmjs.com/package/@webtui/theme-everforest) | ||
|
|
||
| ## Development | ||
|
|
||
| This repository is a monorepo that contains the website and all the official WebTUI packages. | ||
|
|
||
| 1. Ensure [Bun](https://bun.sh/) is installed | ||
| 2. Clone the repository | ||
| ```bash | ||
| git clone https://github.com/webtui/webtui | ||
| ``` | ||
| 3. Install dependencies | ||
| ```bash | ||
| bun i | ||
| ``` | ||
| 4. Build the project | ||
| ```bash | ||
| bun run build | ||
| ``` | ||
| 4. Start the dev server | ||
| ```bash | ||
| bun run dev | ||
| ``` | ||
| Personal website (redesign!) Using [WebTUI](https://webtui.ironclad.sh) |
There was a problem hiding this comment.
The top-level README is now describing a personal website (sam.onl), but this repository appears to be the WebTUI monorepo (e.g., packages/@webtui/* and web docs at webtui.ironclad.sh). Replacing the root README with personal-site content will likely confuse users and breaks discoverability for installation/development instructions. Consider restoring a WebTUI-focused root README (or at least a brief project overview + links), and if you need a personal-site README, place it under the relevant app directory (e.g., web/) or in a separate repository.
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.
Updated README to reflect personal website redesign using WebTUI.
Fixes #issue-number
What does this PR do?
Checklist
Summary by Sourcery
Documentation: