Skip to content

Rebranded "Roux Components" to just Roux#21

Open
pangolingo wants to merge 1 commit into
component_library_2from
di/component-library-rebrand-roux
Open

Rebranded "Roux Components" to just Roux#21
pangolingo wants to merge 1 commit into
component_library_2from
di/component-library-rebrand-roux

Conversation

@pangolingo
Copy link
Copy Markdown
Contributor

  • added info about components to the repo README
  • updated the docs site to be about "Roux" not "Roux Components"
  • shared copy between the README and homepage

- added info about components to the repo README
- updated the docs site to be about "Roux" not "Roux Components"
- shared copy between the README and homepage
@@ -1,6 +1,6 @@
{%- set siteName = 'Roux Components' -%}
{%- set siteName = 'Roux CSS' -%}
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure if the site title should be just "Roux" or "Roux CSS". I feel like "Roux CSS" might be better for SEO as well as being more self-explanatory in search results.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ooo good question. Should it be maybe Roux CSS and Components then to incorporate both? or Roux CSS and HTML starter if we're going the SEO route?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think "Roux CSS & Components" works well.

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates project and docs-site copy to reflect the “Roux” branding and to share common messaging between the repository README and the documentation homepage, while adding more entry points to the docs site.

Changes:

  • Rewrote the docs homepage content and updated docs-site metadata/labels to match the new positioning.
  • Expanded the root README with “see it in action” links and additional docs-site references.
  • Introduced a shared footer snippet and converted some inline links to reference-style links.

Reviewed changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 6 comments.

Show a summary per file
File Description
site/robots.txt Updates the robots.txt header branding text.
site/README.md Renames the docs-site README title to match current branding.
site/index.md Replaces the docs homepage copy and adds shared footer/link refs.
site/assets/css/site.css Updates docs-site CSS header comments to reflect new naming.
site/_includes/partials/_header.njk Updates the header logo text branding.
site/_includes/layouts/base.njk Updates site name/description used for titles/meta.
README.md Expands README messaging and adds docs-site links/examples.
package.json Updates npm package description to mention HTML components.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines +1 to +3
{%- set siteName = 'Roux CSS' -%}
{%- set siteUrl = 'https://roux.thoughtbot.dev' -%}
{%- set siteDescription = 'Extend Roux CSS with ready-to-use components to build your project.' -%}
{%- set siteDescription = 'A boilerplate of pre-defined native CSS architecture, styling, and HTML to kickstart your project.' -%}
</a>

<a class="header-logo" href="{{ '/' | url }}"> Roux Components </a>
<a class="header-logo" href="{{ '/' | url }}"> Roux CSS</a>
Comment thread site/robots.txt
@@ -1,4 +1,4 @@
# Robots.txt for Roux Components
# Robots.txt for Roux CSS
Comment thread site/assets/css/site.css
Comment on lines +1 to +2
/* Site-specific styles for Roux CSS documentation */
/* These styles are only used for the documentation website, not part of the Roux framework */
Comment thread site/index.md
</nav>
</footer>
```
Checkout the [GitHub README][github] for all the details on how to use Roux. Then come back here to grab the HTML for components.
Comment thread README.md
├── _header.css
├── _navigation.css
└── _footer.css
├── _alert_.css
Comment thread site/index.md

<footer class="page-footer">
- <p class="page-copyright">&copy; 2026 thoughtbot, inc.</p>
## Getting Started
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Deleted all the "getting started" stuff in favor of just pointing at the README.

Comment thread site/index.md
## A boilerplate of native CSS architecture, styling, and HTML to kickstart your project.

Much like Roux CSS, these components are meant as a baseline for you to build on top of, so feel free to adjust as needed. They're flexible and extendable, but opinionated about what matters.
Roux gives you an organized foundation of CSS files, variables, base styles, and simple HTML components so you can start building immediately instead of setting everything up from scratch. It's **a structured starting point for writing your own CSS**—not a framework like Tailwind. Think of it like a GitHub template repo, but for your stylesheets.
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This into text now matches the README for consistency.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Roux gives you an organized foundation of CSS files, variables, base styles, and simple HTML components so you can start building immediately instead of setting everything up from scratch. It's **a structured starting point for writing your own CSS**—not a framework like Tailwind. Think of it like a GitHub template repo, but for your stylesheets.
Roux gives you an organized foundation of CSS files, variables, base styles, and simple HTML components so you can start building immediately instead of setting everything up from scratch. It's **a structured starting point for writing your own CSS and HTML**—not a framework like Tailwind or Material UI. Think of it like a GitHub template repo, but for your stylesheets and basic component markup.

Comment thread README.md
#### Example

**Default modal**
[View example modals on the docs site][docs site modals]
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm keeping the CSS examples in this README, but pointing to the docs site for HTML.

Copy link
Copy Markdown
Contributor

@enatario enatario left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Aw yis! Great stuff, just a few minor comments

@@ -1,6 +1,6 @@
{%- set siteName = 'Roux Components' -%}
{%- set siteName = 'Roux CSS' -%}
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ooo good question. Should it be maybe Roux CSS and Components then to incorporate both? or Roux CSS and HTML starter if we're going the SEO route?

Comment thread site/index.md
## A boilerplate of native CSS architecture, styling, and HTML to kickstart your project.

Much like Roux CSS, these components are meant as a baseline for you to build on top of, so feel free to adjust as needed. They're flexible and extendable, but opinionated about what matters.
Roux gives you an organized foundation of CSS files, variables, base styles, and simple HTML components so you can start building immediately instead of setting everything up from scratch. It's **a structured starting point for writing your own CSS**—not a framework like Tailwind. Think of it like a GitHub template repo, but for your stylesheets.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Roux gives you an organized foundation of CSS files, variables, base styles, and simple HTML components so you can start building immediately instead of setting everything up from scratch. It's **a structured starting point for writing your own CSS**—not a framework like Tailwind. Think of it like a GitHub template repo, but for your stylesheets.
Roux gives you an organized foundation of CSS files, variables, base styles, and simple HTML components so you can start building immediately instead of setting everything up from scratch. It's **a structured starting point for writing your own CSS and HTML**—not a framework like Tailwind or Material UI. Think of it like a GitHub template repo, but for your stylesheets and basic component markup.

Comment thread site/index.md
Roux gives you an organized foundation of CSS files, variables, base styles, and simple HTML components so you can start building immediately instead of setting everything up from scratch. It's **a structured starting point for writing your own CSS**—not a framework like Tailwind. Think of it like a GitHub template repo, but for your stylesheets.

All components are accessible and semantic by default.
You can cherry-pick what you need, use it for inspiration, or adopt the whole system—whatever works for your project. It's flexible and extendable, but opinionated about what matters. All HTML components are accessible and semantic by default.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
You can cherry-pick what you need, use it for inspiration, or adopt the whole system—whatever works for your project. It's flexible and extendable, but opinionated about what matters. All HTML components are accessible and semantic by default.
You can cherry-pick what you need, use it for inspiration, or adopt the whole system—whatever works for your project. It's flexible and extendable, but opinionated about what matters. All HTML components aim to be accessible and semantic by default.

I only suggest now since we can't always claim they are fully accessible since that's a spectrum.

Comment thread site/index.md
You can cherry-pick what you need, use it for inspiration, or adopt the whole system—whatever works for your project. It's flexible and extendable, but opinionated about what matters. All HTML components are accessible and semantic by default.

Find the code in [the Roux repo on GitHub](https://github.com/thoughtbot/roux).
You may have used [Bitters] and [Refills] in the past—move on over to a fully native setup with Roux.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔥

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants