Reordering of README with setup instructions on top

[jeffmaki]

Added detailed instructions for local development setup, including Docker commands and database migration steps.

Summary

• Added detailed local development setup instructions to the README, including Docker-based and no-Docker workflows.
• Documented Docker Compose startup/shutdown commands, database migration steps, testing, type-checking, and formatting.
• Added a repository branch index.
• Reorganized the proxy contract section under deployment and environment guidance while preserving its documented requirements.

[coderabbitai]

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 00f9ce94-5ed8-4c63-aa0c-77a6ab054943

📥 Commits

Reviewing files that changed from the base of the PR and between f332c1d and bf3b4f3.

📒 Files selected for processing (1)

• README.md

---

📝 Walkthrough

Walkthrough

README.md adds a branch index and local development instructions, including Docker, testing, formatting, and type-checking commands. The proxy contract for osm-rails and osm-web is relocated to the deployment documentation section.

Changes

README documentation updates

Layer / File(s)	Summary
Local development setup README.md	Adds the repository branch index and instructions for local startup, Docker Compose, tests, formatting, and type-checking.
Deployment proxy contract README.md	Relocates the proxy requirements covering authorization, user provisioning, tenancy headers, header rewriting, connectivity, and database variables.

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

Possibly related PRs

• TaskarCenterAtUW/workspaces-backend#63: Related README reorganization and expansion of development and deployment documentation.
• TaskarCenterAtUW/workspaces-backend#64: Related changes to local setup and Docker Compose instructions.

Suggested reviewers: susrisha

Poem

I’m a rabbit with docs in my burrow,
Branches and setup now plainly shown.
Proxy rules hop to deployment,
Tests and checks are neatly grown.
Thump, thump—README shines!

---

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.}