Skip to content

Expand README with deployment architecture and services#63

Merged
jeffmaki merged 1 commit into
developfrom
jeffmaki-docs
Jul 14, 2026
Merged

Expand README with deployment architecture and services#63
jeffmaki merged 1 commit into
developfrom
jeffmaki-docs

Conversation

@jeffmaki

@jeffmaki jeffmaki commented Jul 14, 2026

Copy link
Copy Markdown
Contributor

Added detailed deployment architecture and services information to README.

Summary

Expanded README.md with:

  • A deployment architecture diagram covering backend, Rails, cgimap, worker, and Azure Postgres.
  • Detailed descriptions of container responsibilities and database connectivity.
  • Clarification of the two-database model and Alembic migration order.
  • Documentation of environment templating conventions and injected secrets.
  • A local development backend URL: http://localhost:8000.

Added detailed deployment architecture and services information to README.
@coderabbitai

coderabbitai Bot commented Jul 14, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: c78c4cc9-3f6e-4608-ad31-992582be944a

📥 Commits

Reviewing files that changed from the base of the PR and between 5b1127e and 730d488.

📒 Files selected for processing (1)
  • README.md

📝 Walkthrough

Walkthrough

README.md now documents deployment architecture, service roles, database separation and migrations, environment templating, and local backend access.

Changes

Deployment documentation

Layer / File(s) Summary
Architecture and setup documentation
README.md
Documents container connectivity, service database usage, the two Alembic migration trees, environment-based configuration, injected secrets, and the local backend URL.

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

Suggested reviewers: susrisha

Poem

I’m a rabbit with docs in my paws,
Mapping services and database laws.
Two migration trails hop into view,
Environment secrets are templated too.
And localhost welcomes the crew!


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

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

@jeffmaki
jeffmaki merged commit d9899f9 into develop Jul 14, 2026
2 of 3 checks passed
@jeffmaki
jeffmaki deleted the jeffmaki-docs branch July 14, 2026 14:19
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