Skip to content

docs: restore full root README and move EC2 guide into docs/ - #17

Merged
ayushcmd merged 6 commits into
mainfrom
docs/restore-full-readme-and-move-ec2-guide
Oct 27, 2026
Merged

ayushcmd merged 6 commits into
mainfrom
docs/restore-full-readme-and-move-ec2-guide

Conversation

@ayushcmd

Copy link
Copy Markdown
Owner

Fixes the README and document placement

This corrective PR aligns the repository with the intended structure.

Intended result

  • Restore the full, detailed project README as the root README.md so it remains the main GitHub landing page.
  • Keep docs/PROJECT_BUILD_AND_ARCHITECTURE.md.
  • Keep docs/AWS_DEPLOYMENT_AND_OPERATIONS.md.
  • Move the existing DEPLOY_TO_EC2.md into docs/DEPLOY_TO_EC2.md without changing its contents.
  • Remove the duplicate docs/README.md after promoting its full contents to the root.
  • Fix relative links in the restored README and links back to the root README in the detailed guides.

Validation

  • Verified root README is the full-length version (~15.7 KB) and contains the project idea, setup, API catalog, monitoring details and team.
  • Verified the three requested guides exist under docs/.
  • Verified the moved DEPLOY_TO_EC2.md has the same content and SHA as the original root file.
  • Checked local Markdown links in the four resulting documents; no broken repository-local links were found.
  • Documentation-only: no application code, Compose files, GitHub workflows, AWS resources or production data are modified.

Review

Please verify the root README stays the main project page and the three requested guides are grouped under docs/.

@ayushcmd ayushcmd self-assigned this Oct 27, 2026
@ayushcmd
ayushcmd merged commit c47bb03 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