From d3ff6d17cc9b37c38d233bdc07aea10485fe96e9 Mon Sep 17 00:00:00 2001 From: Al Date: Fri, 10 Jan 2025 10:31:13 +0100 Subject: [PATCH] docs: add debugger ref; remove note from algopy testing doc as its no longer in preview (#368) * docs: add debugger ref; remove note from algopy testing doc as its no longer in preview * docs: apply suggestions from code review Co-authored-by: Rob Moore (MakerX) --------- Co-authored-by: Rob Moore (MakerX) --- docs/index.md | 3 ++- .../index.md => references/algopy_testing.md} | 2 -- docs/references/avm_debugger.md | 7 +++++++ 3 files changed, 9 insertions(+), 3 deletions(-) rename docs/{algopy_testing/index.md => references/algopy_testing.md} (89%) create mode 100644 docs/references/avm_debugger.md diff --git a/docs/index.md b/docs/index.md index 5b69571f85..7a43cbdfe1 100644 --- a/docs/index.md +++ b/docs/index.md @@ -59,5 +59,6 @@ language-guide principles api compiler -algopy_testing/index +references/algopy_testing +references/avm_debugger ``` diff --git a/docs/algopy_testing/index.md b/docs/references/algopy_testing.md similarity index 89% rename from docs/algopy_testing/index.md rename to docs/references/algopy_testing.md index b18e66f10d..0fa2b0338c 100644 --- a/docs/algopy_testing/index.md +++ b/docs/references/algopy_testing.md @@ -8,8 +8,6 @@ The `algorand-python-testing` package provides: - An offline testing environment that simulates core AVM functionality - A familiar Pythonic experience, compatible with testing frameworks like [pytest](https://docs.pytest.org/en/latest/), [unittest](https://docs.python.org/3/library/unittest.html), and [hypothesis](https://hypothesis.readthedocs.io/en/latest/) -> **NOTE**: This package is currently in **preview** and should be used with caution until the first stable release. - ## Quick Start To get started refer to the [official documentation](https://algorandfoundation.github.io/algorand-python-testing/). diff --git a/docs/references/avm_debugger.md b/docs/references/avm_debugger.md new file mode 100644 index 0000000000..84b0fbeb50 --- /dev/null +++ b/docs/references/avm_debugger.md @@ -0,0 +1,7 @@ +# Breakpoint debugging + +The AlgoKit AVM VS Code Debugger extension enables line-by-line debugging of Algorand Python smart contracts that are executed on the AVM. It provides a seamless debugging experience by leveraging AVM simulate traces and source maps. + +## Quick Start + +For detailed setup instructions, features, and advanced usage, please refer to the [official repository](https://github.com/algorandfoundation/algokit-avm-vscode-debugger).