Skip to content

Improve README: tech stack, resources, collapsible issues, credential tables, contributors#6883

Open
compwron wants to merge 2 commits intomainfrom
readme-improvements-2026-04-23
Open

Improve README: tech stack, resources, collapsible issues, credential tables, contributors#6883
compwron wants to merge 2 commits intomainfrom
readme-improvements-2026-04-23

Conversation

@compwron
Copy link
Copy Markdown
Collaborator

Summary

  • Tech Stack table — Ruby/Rails/Postgres/Node versions and key libraries (Hotwire, Stimulus, RSpec, StandardRB) surfaced near the top
  • Resources section — links to ADRs, DB diagram, product sense, wiki, and calendar moved up from the bottom so they're easy to find
  • Codespaces: remove EXPERIMENTAL label — the setup has been stable; the label discouraged contributors unnecessarily; step 4 now cross-links to the credentials table
  • Common issues → collapsible <details> blocks — six issues are now individually expandable so the list doesn't overwhelm first-time readers
  • Seed credentials → tables — passwords are now inline next to each email, and local + QA URLs are shown side-by-side
  • QA environment subsectioncasa-qa.herokuapp.com was buried in a parenthetical; it now has its own named section
  • Proper ### subheadings inside Running the App — "Local email", "Running Tests", and "Cleaning up" were bold text, not real headings; fixed so they appear in the TOC
  • Frontend Architecture subsection — the orphaned "Stimulus" paragraph is expanded into a proper section explaining Hotwire/Turbo/Stimulus with a pointer to the controllers directory
  • Keeping Your Local Environment Up to Datebin/update and After Party tasks moved into a dedicated section so developers know to run this after every git pull main
  • Contributors section — all-contributors spec and bot instructions added so contributors can request attribution
  • Windows platform entry — "Help Wanted" removed; now links to the WSL guide as the recommended Windows path
  • TOC updated to reflect all new sections (re-run npx doctoc README.md to finalize the generated anchors)

Test plan

  • Read through the rendered README on GitHub and verify all links resolve
  • Confirm <details> blocks expand/collapse correctly in the GitHub Markdown renderer
  • Re-run npx doctoc README.md and commit the result if anchor hashes differ from the manually updated TOC
  • Verify QA environment URL is still live at https://casa-qa.herokuapp.com/

🤖 Generated with Claude Code

…s, contributors

- Add Tech Stack table (Ruby/Rails/Postgres/Node versions + key libraries)
- Add Resources section near top (ADRs, DB diagram, product sense, wiki, calendar)
- Remove EXPERIMENTAL label from Codespaces section
- Collapse common issues into <details> blocks for scannability
- Replace flat seed-user list with tables that include passwords inline
- Add QA environment subsection with direct URL
- Replace bold pseudo-headers with proper ### subheadings under Running the App
- Expand Stimulus note into Frontend Architecture subsection (Hotwire/Turbo/Stimulus)
- Add Keeping Your Local Environment Up to Date section (bin/update + after_party)
- Add Contributors section with all-contributors bot instructions
- Fix Windows platform entry (remove "Help Wanted", link to WSL guide)
- Update TOC to reflect new structure (re-run doctoc to finalize)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
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.

1 participant