Skip to content

docs: restructure README overview and requirements - #8601

Open
joshtrichards wants to merge 5 commits into
mainfrom
jtr/refine-readme-intro-features-reqs
Open

docs: restructure README overview and requirements#8601
joshtrichards wants to merge 5 commits into
mainfrom
jtr/refine-readme-intro-features-reqs

Conversation

@joshtrichards

@joshtrichards joshtrichards commented Aug 21, 2026

Copy link
Copy Markdown
Member
  • 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

  • Rewrite the README introduction and clarify who Nextcloud AIO is intended for
  • Reorganize and categorize the Features section, including the expandable list of detailed capabilities
  • Add a standalone “How does it work?” (dropping the FAQ entry) section describing (briefly) orchestration, HTTPS, integrations, and customization
  • Add a Core Requirements section covering supported platforms, runtimes, domains, architectures, and storage
  • Rename the installation walkthrough to “Quickstart”
  • Move the architecture overview below the Quickstart section (less overwhelming, more logical needs-driven ordering)
  • Improve terminology, formatting, and documentation links throughout the overview

Notes

  • The detailed feature list remains collapsed to keep the README easier to scan
  • User-count and Enterprise guidance is phrased conservatively. Additionally no secret is made of their being other installation methods.
  • Community-maintained containers are explicitly identified as having separate support, update, security, and compatibility considerations.

TODO

  • Make sure most of the key hyperlinks are still in place after moving things around / editing

Future follow-up ideas

  • Move the FAQ out to a dedicated FAQ.md file.

Summary

  • The PR was tested and verified that it works locally
  • Or will be tested after merge on a dedicated test instance (available for maintainers)
  • Sign-off message is added to all commits
  • Tests (playwright if possible) are included
  • Screenshots before/after for front-end changes
  • Documentation has been updated or is not required
  • Labels added where applicable (ex: bug/enhancement, 3. to review, feature component)
  • Milestone next added

AI (if applicable)

  • The content of this PR was partly or fully generated using AI

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>
@joshtrichards joshtrichards added 3. to review Waiting for reviews documentation Improvements or additions to documentation labels Aug 21, 2026
@szaimen
szaimen requested review from pabzm and a balanced review from Copilot August 22, 2026 15:09

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread readme.md

The information above is only a summary. See the FAQ for detailed requirements, caveats, and platform-specific guidance.

## Quickstart
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

3. to review Waiting for reviews documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants