docs: add VS Code attach snippet, fix duplicate table, expand extension points, add batch execution design doc#1372
Merged
Merged
Conversation
…on points, add batch execution design doc
|
@TeeYml Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
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.
docs: Fix four documentation gaps across remote debugging, README, architecture, and batch execution
Summary
This PR resolves four backlog documentation issues (I-003, I-014, I-018, I-024) identified in
docs/issues/backlog-100-issues.md. All changes are documentation-only — no source code is modified.Changes
#935 — Add complete
launch.jsonsnippet for the VS Code attach flowdocs/remote-debugging.mdcovered TLS server setup and the CLIremotecommand but left VS Code users without a concrete attach configuration to copy. Added a new "Connect from VS Code (Attach)" subsection directly after the CLI client example. It includes a complete.vscode/launch.jsonsnippet with all relevant fields (host,port,contractPath,entrypoint,args,token,tlsCert,tlsKey) and an inline property reference table so users can understand each field without leaving the page.Closes #935
#917 — Consolidate duplicated Storage Filtering pattern table in README
The
README"Storage Filtering" section contained the same pattern table (balance:*/ regex / exact match) in two places — once immediately after the shell examples and once orphaned below the trace JSON block (lines 200–209). Moved the table up to sit directly under the "Storage Filtering" heading where it is most useful and removed the duplicate copy below the trace output.Closes #917
#925 — Expand
ARCHITECTURE.mdExtension Points to include plugin system, remote server, and batch executorThe Extension Points section listed four items but omitted three major subsystems that have shipped since the section was written: the plugin system, the remote debug server, and the batch executor. Added three new bullet points — each with a short description of what the subsystem does, how to extend it, and links to the relevant architecture or API docs (
docs/plugin-api.md,docs/architecture-plugins.md,docs/architecture-remote.md,docs/design/batch-execution-design.md).Closes #925
#929 — Add canonical batch execution design reference to
docs/design/The batch execution design (Rayon parallelism, result aggregation, pass/fail logic) existed only in
BATCH_EXECUTION_SUMMARY.md— an implementation summary from the original feature PR, not a design document. Createddocs/design/batch-execution-design.mdas the canonical design reference. It covers: goals and non-goals, component diagram, key types, the Rayon work-stealing parallelism model, result aggregation logic, input file format spec, CLI and VS Code integration, performance characteristics, and extension points. Cross-linked it fromdocs/batch-execution.md(user guide) andARCHITECTURE.md.Closes #929