docs: make README capabilities-first#87
Merged
simongdavies merged 2 commits intohyperlight-dev:mainfrom Apr 28, 2026
Merged
Conversation
Signed-off-by: Simon Davies <simongdavies@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR refreshes HyperAgent’s documentation to be more “capabilities-first”, expanding the CLI/environment variable reference, clarifying how resource profiles behave (startup vs runtime application), and updating module/MCP guidance for users.
Changes:
- Expanded CLI flag and environment-variable tables (including prompt-file, skip-suggest, output threshold, MCP/session options).
- Clarified profile semantics (what
--profiledoes at startup vs/profile apply/apply_profileduring a session) and updated profile limits. - Updated README positioning, examples, and documentation index to emphasize explicit host capabilities, plugins, profiles, and MCP.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 10 comments.
| File | Description |
|---|---|
| docs/USAGE.md | Updates CLI/env-var reference, adds slash commands, revises tool and builtin-module listings, clarifies profile behavior. |
| docs/PROFILES.md | Clarifies the two profile application paths and updates examples/tables for new profile limits/usage. |
| README.md | Reworks the README narrative and examples around explicit capabilities, profiles, plugins, and MCP. |
Signed-off-by: Simon Davies <simongdavies@users.noreply.github.com>
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.
This pull request updates the documentation for HyperAgent, focusing on clarifying and expanding the usage of resource profiles, enhancing CLI/environment variable options, and improving module reference information. The changes make the documentation more accurate, comprehensive, and easier to follow for both new and existing users.