[Docs] Add content depth to README - #881
Draft
roomote-roomote[bot] wants to merge 2 commits into
Draft
Conversation
Expands the README with a table of contents, tech stack overview, example tasks, configuration reference, and troubleshooting guide.
Contributor
Author
|
2 issues outstanding. See task
Reviewed e8dab40 |
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.
What changed
Expanded the README with additional content depth for readers evaluating or contributing to Roomote:
Why this change was made
The original README was strong on product positioning but light on practical reference material. Someone discovering Roomote for the first time had to click through to external docs for basic configuration, troubleshooting, and contribution workflows. This change brings the most-needed information into the README itself.
Impact
No user-facing behavior change. This is a documentation-only update that makes the project more approachable for new users and contributors.