-
-
Notifications
You must be signed in to change notification settings - Fork 527
CLAUDE
Table of Contents generated with DocToc
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
This is the GitHub wiki for the CASA (Court Appointed Special Advocates) Ruby for Good project — git@github.com:rubyforgood/casa.wiki.git. It is a documentation-only repo: every top-level .md file is a single wiki page rendered at https://github.com/rubyforgood/casa/wiki/<filename-without-extension>. There is no application code, no build, no test suite, and no package manifest in this repo.
The actual CASA application lives in a separate repo: github.com/rubyforgood/casa. Many wiki pages document commands, workflows, and architecture for that repo (Rails console commands, RSpec/Jest invocations, deploy steps, Flipper feature flags, etc.). Those commands are not runnable here — they are reference material for contributors working in the application repo.
-
Filename = wiki slug.
Helpful-Commands.mdbecomes the pageHelpful Commands. Hyphens render as spaces. Don't rename files casually — it breaks every inbound link from other pages and from the application repo. -
Special characters in filenames. A couple of files have URL-unsafe characters in their slug —
Who's-who?.mdis linked from other pages asWho's-who%3F, andMetrics-[prod].mdasMetrics-%5Bprod%5D. Preserve those encodings when linking. (Earlier versions of this wiki also used the Unicode hyphen‐(U+2010) in some filenames; those have been renamed to ASCII-.) -
Internal links use either the bare wiki slug (
[Components](Components)) or the full URL (https://github.com/rubyforgood/casa/wiki/Components). Both forms appear; match the surrounding style of the page you're editing. -
Home.mdis the wiki landing page and the index from which most other pages are reached. When adding a new page, add a link fromHome.md(or another appropriate hub page) so it's discoverable. -
doctoc TOCs. Many pages start with a doctoc-generated table of contents wrapped in
<!-- START doctoc ... -->/<!-- END doctoc ... -->markers. If you change a page's headings, regenerate that block (doctoc <file>) rather than hand-editing it. -
Auto-generated commit messages. Commits like
Updated <Page Name> (markdown)andCreated <Page Name> (markdown)come from GitHub's wiki web editor. When committing locally, write a normal descriptive message — don't try to mimic that format.
- Edits are plain markdown changes. There is nothing to build or lint; preview rendering by viewing the file on GitHub or locally with any markdown renderer.
- The wiki is publicly editable through GitHub's web UI, so this repo can receive commits from outside this clone.
git pullbefore starting work on a page. - Before adding a new page, check
Home.mdand search existing files (ls *.md) for a page that already covers the topic — many pages overlap (e.g. multiple "how to" guides for the same subsystem).