Skip to content

Add function call tracing documentation#187

Merged
gnidan merged 4 commits intocall-returnfrom
writer-call-tracing-docs
Mar 11, 2026
Merged

Add function call tracing documentation#187
gnidan merged 4 commits intocall-returnfrom
writer-call-tracing-docs

Conversation

@gnidan
Copy link
Member

@gnidan gnidan commented Mar 11, 2026

Adds invoke/return/revert context documentation across concept, reference, and spec pages:

  • concepts/programs.mdx — new "Function call contexts" section explaining the three context types with a SchemaExample for an internal call
  • tracing.mdx — walkthrough of tracing through a function call using a BUG-like Adder contract, covering internal calls (invoke/return), external message calls, and reverts with reason/panic examples
  • Spec pages — added intro prose to function.mdx, return.mdx, and revert.mdx (were bare SchemaViewer components)

Prose reviewed by style agent before push.

@github-actions
Copy link
Contributor

github-actions bot commented Mar 11, 2026

PR Preview Action v1.8.1
Preview removed because the pull request was closed.
2026-03-11 08:40 UTC

gnidan added 4 commits March 11, 2026 04:28
Add invoke/return/revert context documentation across concept,
reference, and spec pages:

- concepts/programs.mdx: new "Function call contexts" section
  explaining the three context types with a SchemaExample
- tracing.mdx: walkthrough of tracing through an internal function
  call (Adder contract), plus external call and revert examples
- Spec pages: added intro prose to function.mdx, return.mdx,
  revert.mdx
Replace the static BUG code block with an interactive TraceExample
component that lets readers compile and step through the Adder
contract, seeing invoke/return contexts at function boundaries.

Static SchemaExample blocks are kept for the narrative walkthrough
and for external call/revert examples (which BUG can't demonstrate).
Add 2-space indentation inside block bodies (storage, create, code,
if) to match the canonical style used in .bug example files.
Prettier strips indentation inside template literal strings in MDX
JSX props. Revert to the unindented style that prettier enforces.
@gnidan gnidan force-pushed the writer-call-tracing-docs branch from f6e8712 to d9240b4 Compare March 11, 2026 08:28
@gnidan gnidan merged commit 8864511 into call-return Mar 11, 2026
4 checks passed
@gnidan gnidan deleted the writer-call-tracing-docs branch March 11, 2026 08:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant