Skip to content

docs: move detailed project documents into docs/ - #16

Merged
ayushcmd merged 7 commits into
mainfrom
docs/organize-documentation-folder
Oct 27, 2026
Merged

ayushcmd merged 7 commits into
mainfrom
docs/organize-documentation-folder

Conversation

@ayushcmd

Copy link
Copy Markdown
Owner

Summary

Follow-up documentation cleanup. The previous documentation PR (#15) has already been merged with the full-length files in the repository root; this PR moves those documents into a dedicated docs/ folder.

Proposed structure

  • README.md (root): concise repository landing page linking to the documentation.
  • docs/README.md: full project overview, problem statement, tech stack, demo URL, local installation, endpoint summary, and team.
  • docs/PROJECT_BUILD_AND_ARCHITECTURE.md: detailed end-to-end architecture and component guide.
  • docs/AWS_DEPLOYMENT_AND_OPERATIONS.md: AWS deployment and operations runbook.

Safety and accuracy

  • Updates relative Markdown links for the new folder locations.
  • Preserves the PostgreSQL volume safety reminders.
  • Keeps the current demo URL clearly marked as HTTP.
  • Retains the distinction between local and production Compose services and the known CI/CD SSH connectivity blocker.
  • Documentation-only: no application source, Compose configuration, GitHub Actions workflow, AWS resource, or production data is intentionally changed.

Review note

Review the file moves and links before merging. The previous PR (#15) is already merged; this PR contains the additional folder organization.

@ayushcmd ayushcmd self-assigned this Oct 27, 2026
@ayushcmd
ayushcmd merged commit a075fb4 into main Oct 27, 2026
3 checks passed
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