Improve README: tech stack, resources, collapsible issues, credential tables, contributors#6883
Open
Improve README: tech stack, resources, collapsible issues, credential tables, contributors#6883
Conversation
…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>
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.
Summary
<details>blocks — six issues are now individually expandable so the list doesn't overwhelm first-time readerscasa-qa.herokuapp.comwas buried in a parenthetical; it now has its own named section###subheadings inside Running the App — "Local email", "Running Tests", and "Cleaning up" were bold text, not real headings; fixed so they appear in the TOCbin/updateand After Party tasks moved into a dedicated section so developers know to run this after everygit pull mainnpx doctoc README.mdto finalize the generated anchors)Test plan
<details>blocks expand/collapse correctly in the GitHub Markdown renderernpx doctoc README.mdand commit the result if anchor hashes differ from the manually updated TOC🤖 Generated with Claude Code