README as docs; fold OMP into Pi footnote - #118
Conversation
Reviewer's GuideREADME is reworked into the primary documentation, expanding and restructuring content around workflow, commands, configuration, and troubleshooting, while Pi/OMP support is now described as a single Pi* harness with a footnote clarifying that OMP extends Pi with roles and MCP; related comparison tables and docs pages are updated accordingly. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: e98da9e167
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
|
||
| It also ships five generic Markdown roles: | ||
| ```bash | ||
| dotagents skill promote my-skill # finds it in a native skill root, copies it under ~/.agents |
There was a problem hiding this comment.
Document the PR behavior of skill promote
In this local-canonicalization example, the command is described as just finding a native skill and copying it under ~/.agents, but runPromote only skips the git checkout/commit/push and gh pr create path when --dry-run is supplied. In a configured repo this can create a branch/PR, or fail after changing branches, for users who only wanted to copy a harness-local skill; please include --dry-run here or explicitly describe the PR behavior.
Useful? React with 👍 / 👎.
| \* Vanilla [pi](https://github.com/earendil-works/pi) is skills-only by design. If you run the OMP fork instead, dotagents detects it separately and additionally manages roles and MCP servers there — the two never conflict. | ||
|
|
||
| ## Public starter content | ||
| Amp, OpenCode, and OpenClaw can read the repo's skills through standard conventions but are not managed; a surface gets a "yes" above only after its native behavior is verified end to end. |
There was a problem hiding this comment.
Describe Amp as opt-in managed support
This now says Amp is “not managed”, but the harness registry has Amp skill inspection/setup and MCP support, and setup accepts --agents=amp, so Amp users are steered away from an existing opt-in managed path for skills/MCP. If Amp is not a default target, this should say compat/opt-in rather than unmanaged; OpenCode and OpenClaw can remain compatibility-only.
Useful? React with 👍 / 👎.
Two changes:
README rework. With no docs site, the README now carries that role: Why → Quick start (full setup walkthrough) → What it syncs → per-surface guides (skills, external pinning, MCP, roles, hooks/memory) → command reference → configuration (resolution order, local overlay) → troubleshooting (incl. legacy pi→omp note) → comparison. Generated skills block untouched.
OMP folded into Pi. OMP no longer appears as a separate harness in comparisons — the README table, harness-map (HTML + regenerated PNG), and landing page now show Pi* with a footnote: vanilla pi is skills-only by design; on the OMP fork dotagents additionally manages roles and MCP. No code changes — the omp adapter still works.
Summary by Sourcery
Rework the README into a comprehensive, user-facing documentation hub and update harness documentation to fold the OMP fork into Pi with clarified support details.
Enhancements:
Documentation: