docs: draft rewritten README for review

[jackgranatowski]

Summary

• Parks a corrected/rewritten README.md draft in copy-wip/github-readme.md for review before promotion to the repo root.
• Fixes stale facts in the current README: token count (685, not 840), cascade layer count (fifteen, not sixteen), a hardcoded landing-page version, and a misleading npm package link (slashed on npm is an unrelated project).
• Adds a "the name is the philosophy" section expanding the SLASHED acronym (Standalone, Lean, Agnostic, Structured, Hybrid, Explicit, Deterministic), each letter grounded in a documented framework behavior.

Context

Split out of #492, which started as this README rewrite but grew to also include an unrelated landing-page redesign (animated hero, bento demos, CDN loading, several bugfixes). See #492 for that half, which is being closed in favor of this PR and #[landing-page PR].

Test plan

• Review the draft prose in copy-wip/github-readme.md for accuracy and tone
• On approval, promote the content to README.md at repo root and delete copy-wip/github-readme.md

🤖 Generated with Claude Code

---

Generated by Claude Code

Summary by CodeRabbit

• Documentation
  • Added a comprehensive README with branding, product overview, setup guidance, and links to key resources.
  • Documented framework concepts, included features, dark mode usage, cascade-layer ordering, browser support, and CDN/package options.
  • Added integration notes, development and testing commands, contribution guidelines, and license information.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 751bfe7c-376b-4dd4-afb4-9421aa0bb559

📥 Commits

Reviewing files that changed from the base of the PR and between 5f34a8a and 7498bb7.

📒 Files selected for processing (1)

• copy-wip/github-readme.md

---

📝 Walkthrough

Walkthrough

This PR adds a new draft README file (copy-wip/github-readme.md) containing the complete GitHub README content for the SLASHED CSS framework, including branding, philosophy, feature descriptions, usage instructions, bundling/CDN details, browser support, documentation links, and development guidance.

Changes

README Content Addition

Layer / File(s)	Summary
Branding, links, and philosophy overview copy-wip/github-readme.md	Adds header with logo/badges, top-level links (website, configurator, docs, changelog), and the "name is the philosophy" overview section.
Feature overview: contents, dark mode, cascade layers copy-wip/github-readme.md	Documents "What's inside" bullets, dark mode usage with data-theme example, and the fifteen-layer cascade model.
Bundles, browser support, and documentation reference copy-wip/github-readme.md	Describes release/CDN bundle variants and à la carte loading, browser feature support table, and documentation guide table.
WordPress integration and development instructions copy-wip/github-readme.md	Adds WordPress plugin pointer, npm development commands, contribution conventions, and MIT license line.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Possibly related PRs

• codeslash-dev/SLASHED#48: Both PRs modify the project's README documentation content/sections such as philosophy, features, and usage guidance.
• codeslash-dev/SLASHED#70: Overlaps with token rebranding/configuration wording around required light/dark token rebrands.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately summarizes the main change: a rewritten README draft prepared for review.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch claude/readme-copy-review

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[qodo-code-review]

PR Summary by Qodo

Add rewritten GitHub README draft under copy-wip for review

📝 Documentation 🕐 10-20 Minutes

AI Description

• Add a new GitHub-focused README draft in copy-wip/ for review.
• Correct stale README facts (token/layer counts, versioning, npm link).
• Introduce an acronym section tying SLASHED’s name to documented behaviors.

Diagram

graph TD
A["copy-wip/github-readme.md (draft)"] --> B["Reviewer feedback"] --> C["Promote to README.md"] --> D["Public repo landing"]
A --> E["Links to docs/*"]
C --> F["Remove draft file"]

Loading

High-Level Assessment

The following are alternative approaches to this PR:

1. Directly replace root README.md in this PR

• ➕ Single-step change; avoids duplicated README sources
• ➕ Lets reviewers see the exact end-state immediately
• ➖ Higher perceived blast radius for a large copy change
• ➖ Harder to iterate on tone/structure without 'breaking' the landing page in-flight

2. Use a GitHub Discussion / issue for copy review, then open a small README PR

• ➕ Keeps repo diffs smaller and focused on code/content promotion
• ➕ Allows broader async feedback without PR noise
• ➖ Splits review context away from the exact markdown rendering and links in-repo
• ➖ Adds coordination overhead and an extra promotion step anyway

Recommendation: Keeping the rewrite in copy-wip/github-readme.md is a good low-risk approach for a prose-heavy, accuracy-sensitive change; it enables iterative copy review without immediately changing the public-facing root README. If/when approved, follow up with a promotion PR (or a second commit) that replaces README.md and deletes the draft file to prevent drift.

Files changed (1) +191 / -0

Documentation (1) +191 / -0

github-readme.mdAdd rewritten README draft with corrected facts and expanded positioning +191/-0

Add rewritten README draft with corrected facts and expanded positioning

• Introduces a new GitHub README draft under 'copy-wip/' with updated headline claims and corrected project facts (e.g., token count, cascade-layer count, and link targets). Adds a "The name is the philosophy" section expanding the SLASHED acronym into explicit, source-checkable commitments, plus refreshed sections for bundles, browser support, docs links, and development commands.

copy-wip/github-readme.md

[qodo-code-review]

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📜 Skill insights (0)

Context used

✅ Compliance rules (platform): 11 rules

1. Broken relative README links ✗ Dismissed 🐞 Bug ≡ Correctness

Description

copy-wip/github-readme.md contains relative links like "LICENSE", "docs/architecture.md", and
"CHANGELOG.md" that are correct only if the file is at repo root. Because the draft lives under
copy-wip/, these resolve to copy-wip/* paths and break for reviewers navigating the draft.

Code

copy-wip/github-readme.md[R11-24]

+  <a href="https://github.com/codeslash-dev/SLASHED/tags"><img alt="version" src="https://img.shields.io/github/v/tag/codeslash-dev/SLASHED?sort=semver&label=version&color=blueviolet&logo=css3"></a>
+  <a href="https://github.com/codeslash-dev/SLASHED/actions/workflows/ci.yml"><img alt="CI" src="https://img.shields.io/github/actions/workflow/status/codeslash-dev/SLASHED/ci.yml?branch=main&label=CI&logo=github"></a>
+  <a href="LICENSE"><img alt="license" src="https://img.shields.io/github/license/codeslash-dev/SLASHED"></a>
+  <a href="https://cdn.jsdelivr.net/gh/codeslash-dev/SLASHED@dist/slashed.optimal.min.css"><img alt="optimal bundle" src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/codeslash-dev/SLASHED/dist/badge-optimal.json"></a>
+  <a href="package.json"><img alt="runtime deps" src="https://img.shields.io/badge/runtime_deps-zero-brightgreen"></a>
+  <a href="https://cdn.jsdelivr.net/gh/codeslash-dev/SLASHED@dist/"><img alt="CDN" src="https://img.shields.io/badge/CDN-jsDelivr-e84d3d?logo=jsdelivr&logoColor=white"></a>
+</p>
+
+<p align="center">
+  <a href="https://slashed.codeslash.dev">Website</a> ·
+  <a href="https://slashed.codeslash.dev/configurator/">Configurator</a> ·
+  <a href="docs/architecture.md">Documentation</a> ·
+  <a href="CHANGELOG.md">Changelog</a>
+</p>

Relevance

⭐⭐⭐ High

Team routinely fixes broken docs/asset paths after moves; accepted similar path/link corrections in
PRs #415 and #175.

PR-#415
PR-#175
PR-#280

ⓘ Recommendations generated based on similar findings in past PRs

Evidence

The draft README is located under copy-wip/ but uses root-style relative links (e.g., LICENSE,
docs/architecture.md). The actual referenced files exist at repo root and under /docs, so these
links won’t resolve correctly from within copy-wip/.

copy-wip/github-readme.md[11-24]
copy-wip/github-readme.md[70-75]
copy-wip/github-readme.md[91-92]
copy-wip/github-readme.md[159-172]
copy-wip/github-readme.md[187-191]
LICENSE[1-3]
docs/architecture.md[1-7]
CHANGELOG.md[1-8]
CONTRIBUTING.md[1-5]

Agent prompt

The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

### Issue description
`copy-wip/github-readme.md` is stored under `copy-wip/`, but many internal links (LICENSE, docs/*, CHANGELOG.md, CONTRIBUTING.md, core/*) are authored as if the document were in the repository root. GitHub resolves these links relative to the current file’s directory, so they point to non-existent `copy-wip/...` targets.

### Issue Context
This file is intended for review before being promoted to the repo root, but reviewers will currently hit broken navigation links while reviewing the draft in-place.

### Fix Focus Areas
Update internal links to resolve correctly from `copy-wip/` (e.g., prefix with `../`), or switch to full GitHub blob URLs for links that should work regardless of file location.

- copy-wip/github-readme.md[11-24]
- copy-wip/github-readme.md[70-75]
- copy-wip/github-readme.md[91-92]
- copy-wip/github-readme.md[159-172]
- copy-wip/github-readme.md[187-191]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

---