Repository navigation
docs: Conduit ecosystem packaging and agent guide - #5
Draft
jordanpartridge wants to merge 4 commits into
Draft
jordanpartridge wants to merge 4 commits into
jordanpartridge wants to merge 4 commits into
Conversation
![lexi-chief-of-staff[bot]](https://avatars.githubusercontent.com/in/3490641?s=60&v=4){kind=small}
There was a problem hiding this comment.
Blocking items:
- README links to docs/agent-output.md which does not exist.
- docs/conduit.md reference claims richer agent recipes than what the new file actually contains.
Other notes:
- CI workflow, AGENTS.md, composer metadata, and ecosystem positioning are clean.
- composer.lock bump is large but expected from the PHP 8.3 + updated deps.
No runtime changes; docs/packaging only. Ship after the two doc links are fixed.
jordanpartridge
force-pushed
the
cursor/conduit-ecosystem-docs-6412
branch
from
September 10, 2026 05:51
170c0e2 to
638d263
Compare
There was a problem hiding this comment.
Blocking: composer.json is invalid after the edit.
- composer.json:60 adds
"scripts"directly after"bin"array without a trailing comma on the preceding line, producing parse error. - No other issues; docs and README changes are clean and match the stated intent.
Contributor
Author
|
Addressed the blocking review:
Please re-review 5361a53. |
There was a problem hiding this comment.
Ship it.
- Docs-only + packaging; no runtime changes.
composer.jsonscripts and keywords are additive and match the new agent focus.- AGENTS.md and docs/conduit.md give clear, actionable guidance for both humans and agents.
- Single docblock addition in CloudflareConnector is harmless.
jordanpartridge
force-pushed
the
cursor/conduit-ecosystem-docs-6412
branch
from
September 10, 2026 13:37
5361a53 to
ace2458
Compare
There was a problem hiding this comment.
Ship it.
- One factual mismatch: composer.json change claims a lockfile update that isn't present.
- Docs and agent guidance are self-consistent and match the stated intent.
- New test covers the expected doc invariants.
- No runtime or correctness changes; packaging/docs only.
All other files look clean. Ready after the lockfile note is addressed.
There was a problem hiding this comment.
Ship it.
- AGENTS.md, docs/conduit.md, demo files, and README ecosystem section match the locked spec exactly (honest
--jsonshape, tunnel:expose coverage, no agent-output.md references). - composer.json keywords/description and platform.php 8.3.33 preserved; tests/Unit/ConduitDocsTest.php enforces the invariants.
- No runtime changes, no envelope claims, no sibling-command conflicts.
- Ready for merge.
2 tasks
Add agent-facing Conduit docs and AGENTS guide, link sibling tools from the README, enrich Packagist keywords, and add a Pest CI workflow. Co-authored-by: Jordan Partridge <jordan@partridge.rocks>
Add AGENTS.md, conduit recipes, hero README, and a demo walkthrough. Enrich Packagist keywords. Document tunnel:expose. Do not link a missing agent-output spec. Leave PHAR install to a later PR. Co-authored-by: Jordan Partridge <jordan@partridge.rocks>
Keep main README install and development. Document pretty-printed API result, tunnel:expose JSON keys, and jq paths. Demo files from the hero-readme branch, patched for tunnel:expose.
cursor
Bot
force-pushed
the
cursor/conduit-ecosystem-docs-6412
branch
from
September 13, 2026 00:46
d371a08 to
b479950
Compare
There was a problem hiding this comment.
Blocking: README still documents the envelope behavior that this PR (and spec.md) explicitly rejects.
- Line 69 (and downstream sections) still say
{"ok":true,"data":...}and link to missing docs/agent-output.md. - Commands, Expose, and tunnel:create paragraphs repeat the stale description.
- docs/conduit.md, AGENTS.md, and the new test all assert the correct raw-result shape; README was only half-patched.
Fix the remaining prose or drop the conflicting sections before merge.
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
2 participants
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.
Summary
Rebased onto latest
main. Docs-only positioning ofcfin the Conduit ecosystem (docs/conduit.md,AGENTS.md, README section, demo walkthrough).Test plan
docs/conduit.mdon GitHub