Merge pull request #98 from algorandfoundation/docs/typos

docs: fix typos and broken links

Author: boblat

README.md

@@ -5,7 +5,7 @@
 [![github-stars](https://img.shields.io/github/stars/algorandfoundation/algorand-typescript-testing?color=74dfdc&logo=star&style=flat)](https://github.com/algorandfoundation/algorand-typescript-testing)
 [![visitor-badge](https://api.visitorbadge.io/api/visitors?path=https%3A%2F%2Fgithub.com%2Falgorandfoundation%2Falgorand-typescript-testing&countColor=%2374dfdc&style=flat)](https://github.com/algorandfoundation/algorand-typescript-testing/)
 
-`algorand-typescript-testing` is a companion package to [Algorand Typescript](https://github.com/algorandfoundation/puya-ts/tree/main/packages/algo-ts) that enables efficient unit testing of Algorand TypeScript smart contracts in an offline environment. This package emulates key AVM behaviors without requiring a network connection, offering fast and reliable testing capabilities with a familiar TypeScript interface.
+`algorand-typescript-testing` is a companion package to [Algorand Typescript](https://github.com/algorandfoundation/puya-ts/tree/main/packages/algo-ts) that enables efficient unit testing of Algorand TypeScript smart contracts in an offline environment. This package emulates key AVM behaviours without requiring a network connection, offering fast and reliable testing capabilities with a familiar TypeScript interface.
 
 The `algorand-typescript-testing` package provides:
 
@@ -46,7 +46,7 @@ Let's write a simple contract and test it using the `algorand-typescript-testing
 
 `algorand-typescript-testing` includes a TypeScript transformer (`puyaTsTransformer`) that ensures contracts (with `.algo.ts` extension) and tests (with `.algo.spec.ts` or `.algo.test.ts` extensions) behave consistently between Node.js and AVM environments.
 
-The transformer replicates AVM behavior, such as integer-only arithmetic where `3 / 2` produces `1`. For code requiring standard Node.js behaviour (e.g., `3 / 2` produces `1.5`), place it in separate `.ts` files and reference them from test files.
+The transformer replicates AVM behaviour, such as integer-only arithmetic where `3 / 2` produces `1`. For code requiring standard Node.js behaviour (e.g., `3 / 2` produces `1.5`), place it in separate `.ts` files and reference them from test files.
 
 The transformer also redirects `@algorandfoundation/algorand-typescript` imports to `@algorandfoundation/algorand-typescript-testing/internal` to provide executable implementations of Algorand TypeScript constructs like `Global`, `Box`, `Uint64`, and `clone`.
 
@@ -302,6 +302,6 @@ To dig deeper into the capabilities of `algorand-typescript-testing`, continue w
 - [Testing Guide](./docs/testing-guide.md)
 - [Examples](./docs/examples.md)
 - [Coverage](./docs/coverage.md)
-- [FQA](./docs/faq.md)
+- [FAQ](./docs/faq.md)
 - [API Reference](./docs/api.md)
 - [Algorand TypeScript](./docs/algots.md)

docs/algots.md

@@ -4,12 +4,10 @@ title: Algorand TypeScript
 
 # Algorand TypeScript
 
-Algorand TypeScript is a partial implementation of the TypeScript programming language that runs on the Algorand Virtual Machine (AVM). It includes a statically typed framework for development of Algorand smart contracts and logic signatures, with TypeScript interfaces to underlying AVM functionality that works with standard TypeScript tooling.
+Algorand TypeScript is a partial implementation of the TypeScript programming language that runs on the Algorand Virtual Machine (AVM). It includes a statically typed framework for developing Algorand smart contracts and logic signatures, and provides TypeScript interfaces to underlying AVM functionality that work with standard TypeScript tooling.
 
-It maintains the syntax and semantics of TypeScript such that a developer who knows TypeScript can make safe assumptions
-about the behaviour of the compiled code when running on the AVM. Algorand TypeScript is also executable TypeScript that can be run
-and debugged on a Node.js virtual machine with transpilation to EcmaScript and run from automated tests.
+It preserves the syntax and semantics of TypeScript so that a developer who knows TypeScript can make safe assumptions about the behaviour of the compiled code when running on the AVM. Algorand TypeScript is also executable TypeScript that can be run and debugged on Node.js after transpilation to ECMAScript and run from automated tests.
 
-Algorand TypeScript is compiled for execution on the AVM by PuyaTs, a TypeScript frontend for the [Puya](https://github.com/algorandfoundation/puya) optimising compiler that ensures the resulting AVM bytecode execution semantics that match the given TypeScript code. PuyaTs produces output that is directly compatible with AlgoKit typed clients to make deployment and calling easy.
+Algorand TypeScript is compiled for execution on the AVM by PuyaTs, a TypeScript frontend for the [Puya](https://github.com/algorandfoundation/puya) optimising compiler. PuyaTs ensures the resulting AVM bytecode has execution semantics that match the given TypeScript code, and it produces output that is directly compatible with AlgoKit typed clients to simplify deployment and invocation.
 
 [Documentation](https://algorandfoundation.github.io/puya-ts/index.html)

docs/api.md

@@ -6,9 +6,7 @@ title: API Reference
 
 An overview of the `algorand-typescript-testing` package - covering the main classes and functions.
 
-```
-Spotted a typo in documentation? This project is open source, please submit an issue or a PR on [GitHub](https://github.com/algorandfoundation/algorand-typescript-testing).
-```
+> Spotted a typo in the documentation? This project is open source; please submit an issue or a PR on [GitHub](https://github.com/algorandfoundation/algorand-typescript-testing).
 
 ## Contexts
 

docs/coverage.md

@@ -4,7 +4,7 @@ title: Coverage
 
 # Coverage
 
-See which `algorand-typescript` stubs are implemented by the `algorand-typescript-testing` library. See the [Concepts](tg-concepts.md#types-of-algorand-typescript-stub-implementations) section for more details on the implementation categories. Refer to the [`algorand-typescript` stubs API](api.md) for the full list of the stubs for which the `algorand-typescript-testing` library provides implementations referenced in the table below.
+See which `algorand-typescript` stubs are implemented in the `algorand-typescript-testing` library. See the [Concepts](tg-concepts.md#types-of-algorand-typescript-stub-implementations) section for more details on the implementation categories. Refer to the [`algorand-typescript-testing` API](api.md) for a full list of stubs implemented by the `algorand-typescript-testing` library, as referenced in the table below.
 
 | Name                         | Implementation type |
 | ---------------------------- | ------------------- |

docs/examples.md

@@ -4,7 +4,7 @@ title: Examples
 
 # Examples
 
-Below is a showcase of various examples of unit testing real and sample Algorand Python smart contracts using `algorand-typescript-testing`.
+Below is a showcase of various examples of unit testing real and sample Algorand TypeScript smart contracts using `algorand-typescript-testing`.
 
 | Contract Name       | Test File                                                                                                                                     | Key Features Demonstrated                                                                                                                                                                                      | Test versions of Algorand TypeScript Abstractions used                                               |
 | ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |

docs/faq.md

@@ -6,7 +6,7 @@ title: FAQ
 
 ## What is a Test Context?
 
-A Test Context is a context manager that provides a simulated Algorand environment for testing TypeScript smart contracts. It allows developers to create and manipulate a virtual Algorand ecosystem for testing purposes. For more details, see the [Test Context section](tg-concepts.md#test-context) in our documentation.
+A test context is a context manager that provides a simulated Algorand environment for testing TypeScript smart contracts. It allows developers to create and manipulate a virtual Algorand ecosystem for testing purposes. For more details, see the [Test Context section](tg-concepts.md#test-context) in our documentation.
 
 ## What is the Algorand Virtual Machine (AVM)?
 
@@ -18,7 +18,7 @@ Operational Codes, or opcodes, are AVM instructions that are executed directly b
 
 ## What are Value Generators?
 
-Value Generators are helper methods that generate randomized values for testing when the specific value of the tested type is not important. In the context of Algorand TypeScript testing, these are represented by property on the context manager, accessed via `any.*` (`any.txn.*`, or `any.arc4.*`. in the case of ARC 4 types). To understand how to use Value Generators effectively, check out our [Value Generators section](tg-concepts.md#value-generators) in the documentation.
+Value Generators are helper methods that generate randomized values for testing when the specific value of the tested type is not important. In the context of Algorand TypeScript testing, these are represented by properties on the context manager, accessed via `any.*` (`any.txn.*` or `any.arc4.*` in the case of ARC 4 types). To understand how to use Value Generators effectively, check out our [Value Generators section](tg-concepts.md#value-generators) in the documentation.
 
 ## What are the limitations of the Algorand TypeScript Testing framework?
 
@@ -30,7 +30,7 @@ The Algorand TypeScript Testing framework emulates the Algorand Virtual Machine
 4. Certain cryptographic operations are mocked or simplified
 5. No state proof generation or verification
 
-For scenarios where these limitations are crucial, it's recommended to pair this framework with integration testing. If you have a solid reason to justify introducing new emulated behaviour, please open an issue or contribute to the project on [Github](https://github.com/algorandfoundation/algorand-typescript-testing).
+For scenarios where these limitations are crucial, it's recommended to pair this framework with integration testing. If you have a good reason to suggest new emulated behaviour, please open an issue or contribute to the project on [GitHub](https://github.com/algorandfoundation/algorand-typescript-testing).
 
 ## How does balance tracking work in the testing framework?
 
@@ -50,16 +50,16 @@ Some cryptographic operations are mocked or simplified in the framework. For a d
 
 ## Can I use this framework for security-critical validations?
 
-While this framework is useful for unit testing and local development, it should not be the only tool used for security-critical validations or performance benchmarking. It's designed to approximate AVM behavior for common scenarios. Always complement your testing with additional integration testing options available in `algokit`, where you can test against real localnet or testnet environments.
+While this framework is useful for unit testing and local development, it should not be the only tool used for security-critical validations or performance benchmarking. It's designed to approximate AVM behaviour for common scenarios. Always complement your testing with additional integration testing options available in `algokit`, where you can test against real localnet or testnet environments.
 
 ## Is there an example of how to use this framework alongside integration tests?
 
-Yes, the `algokit-typescript-template`, accessible via `algokit init`, provides a working example of how to structure `algorand-typecript-testing` along with regular integration tests against localnet.
+Yes, the `algokit-typescript-template`, accessible via `algokit init`, provides a working example of how to structure `algorand-typescript-testing` along with regular integration tests against localnet.
 
 ```
-An `algokit-typescript-template` accessible via `algokit init -t typescript`, provides a comprehensive and customizable working example of how to structure `algorand-typescript-testing` along with regular integration tests against localnet.
+The `algokit-typescript-template` accessible via `algokit init -t typescript` provides a comprehensive and customizable working example of how to structure `algorand-typescript-testing` along with regular integration tests against localnet.
 ```
 
 ## Is it compatible with `vitest`?
 
-Yes, it is compatible with `vitest` and _any_ other TypeScript testing framework as its agnostic of the testing framework as long as it's TypeScript. If you spot incompatibility with a certain tool, please open an issue or contribute to the project on [Github](https://github.com/algorandfoundation/algorand-typescript-testing).
+Yes, it is compatible with `vitest` and _any_ other TypeScript testing framework as its agnostic of the testing framework as long as it's TypeScript. If you spot incompatibility with a certain tool, please open an issue or contribute to the project on [GitHub](https://github.com/algorandfoundation/algorand-typescript-testing).