Repository navigation
feat(diagnostics): add opt-in debug logging and restructure documentation - #82
Closed
benbenbang wants to merge 1 commit into
Closed
benbenbang wants to merge 1 commit into
benbenbang wants to merge 1 commit into
Conversation
benbenbang
enabled auto-merge (rebase)
October 9, 2026 16:30
This change restructures the project documentation, moving the monolithic README content into dedicated guides and introducing installation tooling. The README is trimmed to an installation overview and a documentation index. **Documentation restructure:** * Replaced the large all-in-one README with a concise Installation section and a Documentation table linking to focused guides. * Added `docs/configuration.md`, `docs/debug.md`, `docs/development.md`, `docs/mcp.md`, `docs/releases.md`, `docs/sdk.md`, `docs/updates.md` and `docs/usage.md`, moving CLI usage, configuration, SDK quickstart, debugging, update, release and MCP content out of the README. * Updated cross-references in `docs/mcp-agents.md` to point at the new guide locations instead of README anchors. **Installation tooling:** * Added `scripts/install.sh` to download and verify a release binary into a chosen directory, and documented Homebrew and GitHub install-script flows. * Added `scripts/test_install.py` to exercise the install script behavior.
benbenbang
force-pushed
the
feature/installer
branch
from
October 9, 2026 16:31
9c1123a to
45a95a6
Compare
github-actions
Bot
added
documentation
auto-merge was automatically disabled
October 9, 2026 16:32
Pull request was closed
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.
Operators needed better visibility into failures without leaking sensitive data, and the growing README had become hard to navigate. This change introduces structured debug diagnostics across the application and reorganizes documentation into focused guides with supporting install tooling.
Debug logging:
--debugflag that emits safe JSON diagnostics to stderr without altering normal command output or results.Update diagnostics:
Documentation:
docs/and update cross-references accordingly.Installation tooling:
scripts/install.shto download and verify a release binary, and document Homebrew and install-script flows.Testing: