Repository navigation
docs: move detailed project documents into docs/ - #16
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
Review note
Review the file moves and links before merging. The previous PR (#15) is already merged; this PR contains the additional folder organization.