docs: restructure README overview and requirements - #8601
Open
joshtrichards wants to merge 5 commits into
Open
Conversation
Signed-off-by: Josh <josh.t.richards@gmail.com>
Signed-off-by: Josh <josh.t.richards@gmail.com>
Signed-off-by: Josh <josh.t.richards@gmail.com>
Signed-off-by: Josh <josh.t.richards@gmail.com>
- Correct feature and backup wording - Refine deployment and local-installation claims - Remove the outdated FAQ table-of-contents entry - Clarify user-count and Enterprise guidance - Avoid unsupported commercial thresholds and guarantees Signed-off-by: Josh <josh.t.richards@gmail.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Restructures the README to improve onboarding and clarify AIO’s audience, capabilities, requirements, and architecture.
Changes:
- Reorganizes features and deployment guidance.
- Adds “How does it work?” and core requirements sections.
- Renames installation instructions to “Quickstart” and moves architecture details.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
|
|
||
| The information above is only a summary. See the FAQ for detailed requirements, caveats, and platform-specific guidance. | ||
|
|
||
| ## Quickstart |
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.
Resolves: #This started with messing around with one paragraph and then it got a bit bigger throughout the day. I think this is an improvement, but I'll let others judge if it's an set of suitable refinements.
Summary
Notes
TODO
Future follow-up ideas
FAQ.mdfile.Summary
3. to review, feature component)AI (if applicable)