This repo holds the unified design system for Ruby for Good's Rails applications — CASA, Human Essentials, and Stocks in the Future — synthesized from each project's own design documentation.
-
design.mdis the master document: the synthesized design system, covering principles, color/typography/spacing foundations, components and patterns, accessibility standards, content/voice guidelines, and shared technical conventions. Where the three source projects agree, it states the rule once as the shared standard. Where a value is legitimately project-specific (a brand color, for instance), it's stated explicitly per project rather than papered over. -
INCONSISTENCIES.mdtracks the open, real contradictions between the three source projects — places they disagree about something that isn't supposed to legitimately vary (breakpoint tiers, accessibility conformance level, icon system, control height, modal implementation). This is separate fromdesign.mdon purpose:design.mdis the settled synthesis, this file is the honest list of what hasn't been reconciled yet. -
sources/holds each project's original design documentation, copied verbatim for provenance. Every file below is exactly as it exists in the source repo at the time this synthesis was built:File From sources/casa/design.mdrubyforgood/casa, mainbranch,design.mdsources/casa/design-todo.mdrubyforgood/casa, mainbranch,design-todo.mdsources/human-essentials/design.mdrubyforgood/human-essentials, designbranch,design.mdsources/human-essentials/design-decisions.mdrubyforgood/human-essentials, designbranch,docs/design-decisions.mdsources/human-essentials/accessibility.mdrubyforgood/human-essentials, designbranch,docs/accessibility.mdsources/human-essentials/table-audit.mdrubyforgood/human-essentials, designbranch,docs/table-audit.mdsources/human-essentials/view-audit.mdrubyforgood/human-essentials, designbranch,docs/view-audit.mdsources/stocks-in-the-future/design.mdrubyforgood/stocks-in-the-future, stocksdesignbranch,design.mdsources/stocks-in-the-future/design-instructions.mdrubyforgood/stocks-in-the-future, stocksdesignbranch,design-instructions.mdsources/stocks-in-the-future/design-todo.mdrubyforgood/stocks-in-the-future, stocksdesignbranch,design-todo.mdsources/stocks-in-the-future/responsive-design-guidelines.mdrubyforgood/stocks-in-the-future, stocksdesignbranch,docs/responsive-design-guidelines.mdsources/stocks-in-the-future/type-ahead-and-multiselect.mdrubyforgood/stocks-in-the-future, stocksdesignbranch,docs/type-ahead-and-multiselect.mdThe
table-audit.md,view-audit.md, andtype-ahead-and-multiselect.mdfiles weren't in the original nine documents this synthesis started from — they were pulled in after checking each project'sdocs/directory for other design-relevant material (seedesign.md§9 for the reasoning on what was included vs. left out).
If you're implementing or auditing against this design system, start with design.md. If you hit
a case it doesn't cover cleanly, check INCONSISTENCIES.md first — it may be a known open
question rather than an oversight. For full detail or original wording behind any rule, the
matching sources/ document is the citable original.