Skip to content

Commit

Permalink
docs: add debugger ref; remove note from algopy testing doc as its no…
Browse files Browse the repository at this point in the history
… 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) <rob.moore@makerx.com.au>

---------

Co-authored-by: Rob Moore (MakerX) <rob.moore@makerx.com.au>
  • Loading branch information
aorumbayev and robdmoore authored Jan 10, 2025
1 parent 3c62389 commit d3ff6d1
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 3 deletions.
3 changes: 2 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,5 +59,6 @@ language-guide
principles
api
compiler
algopy_testing/index
references/algopy_testing
references/avm_debugger
```
Original file line number Diff line number Diff line change
Expand Up @@ -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/).
7 changes: 7 additions & 0 deletions docs/references/avm_debugger.md
Original file line number Diff line number Diff line change
@@ -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).

0 comments on commit d3ff6d1

Please sign in to comment.