Docs | Media#8
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
1 participant
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.
This pull request restructures and streamlines the project documentation to make it more accessible and easier to follow. The main
README.mdis simplified into a high-level overview and quick start, while detailed deployment and walkthrough instructions are moved into dedicated markdown files. This improves clarity for new users and separates concerns between getting started, deploying, and running the demo.Documentation Restructuring and Improvements:
README.mdis rewritten for clarity, providing a concise overview, workflow diagram, and a "Quick Start" section, with links to new detailed guides. [1] [2] [3]docs/deployment.mdfile is added with step-by-step deployment instructions, prerequisites, Terraform variables, and cleanup guidance.docs/walkthrough.mdfile is added, detailing how to inject bugs, run the demo, reset the environment, and reference the API.