Merge pull request #88 from algorandfoundation/chore/exclude-impl

refactor: exclude impl folder in build tsconfig to stop IDE suggesting imports from it

Author: boblat

.github/workflows/gh-pages.yml

@@ -0,0 +1,35 @@
+name: 'Run typedoc and publish to pages'
+
+on:
+  push:
+    branches:
+      - main
+jobs:
+  build-and-publish-docs:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      pages: write
+      id-token: write
+    steps:
+      - name: Checkout source code
+        uses: actions/checkout@v4
+
+      - name: Use Node.js 21.x
+        uses: actions/setup-node@v4
+        with:
+          node-version: 21.x
+
+      - name: Npm install
+        run: npm ci --ignore-scripts
+
+      - name: Build doc
+        run: npm run script:documentation
+
+      - name: Upload to GitHub pages
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/_html
+
+      - name: Deploy to GitHub Pages
+        uses: actions/deploy-pages@v4

.gitignore

@@ -55,6 +55,7 @@ test-results.xml
 # Website & Code docs generation
 code-docs/
 out/
+docs/_html
 
 # dotenv environment variable files
 .env

README.md

@@ -287,7 +287,7 @@ To dig deeper into the capabilities of `algorand-typescript-testing`, continue w
 
 #### Contents
 
-- [Testing Guide](./docs/testing-guide/index.md)
+- [Testing Guide](./docs/testing-guide.md)
 - [Examples](./docs/examples.md)
 - [Coverage](./docs/coverage.md)
 - [FQA](./docs/faq.md)

docs/algots.md

@@ -1,3 +1,7 @@
+---
+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.
@@ -8,4 +12,4 @@ and debugged on a Node.js virtual machine with transpilation to EcmaScript and r
 
 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.
 
-[Documentation](https://github.com/algorandfoundation/puya-ts/blob/main/README.md)
+[Documentation](https://algorandfoundation.github.io/puya-ts/index.html)

docs/api.md

@@ -1,29 +1,33 @@
+---
+title: API Reference
+---
+
 # API Reference
 
 An overview of the `algorand-typescript-testing` package - covering the main classes and functions.
 
-```{hint}
+```
 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).
 ```
 
 ## Contexts
 
-- [TestExecutionContext](./code/index/classes/TestExecutionContext.md)
-- [ContractContext](./code/subcontexts/contract-context/classes/ContractContext.md)
-- [LedgerContext](./code/subcontexts/ledger-context/classes/LedgerContext.md)
-- [TransactionContext](./code/subcontexts/transaction-context/classes/TransactionContext.md)
+- [TestExecutionContext](../classes/index.TestExecutionContext.html)
+- [ContractContext](../classes/index._internal_.ContractContext.html)
+- [LedgerContext](../classes/index._internal_.LedgerContext.html)
+- [TransactionContext](../classes/index._internal_.TransactionContext.html)
 
 ## Value Generators
 
-- [AvmValueGenerator](./code/value-generators/avm/classes/AvmValueGenerator.md)
-- [Arc4ValueGenerator](./code/value-generators/arc4/classes/Arc4ValueGenerator.md)
-- [TxnValueGenerator](./code/value-generators/txn/classes/TxnValueGenerator.md)
+- [AvmValueGenerator](../classes/value-generators._internal_.AvmValueGenerator.html)
+- [Arc4ValueGenerator](../classes/value-generators._internal_.Arc4ValueGenerator.html)
+- [TxnValueGenerator](../classes/value-generators._internal_.TxnValueGenerator.html)
 
 ## Utils
 
-- [addEqualityTesters](./code/index/functions/addEqualityTesters.md)
-- [encodingUtils](./code/index/variables/encodingUtil.md)
+- [addEqualityTesters](../functions/index.addEqualityTesters.html)
+- [toExternalValue](../functions/index.toExternalValue.html)
 
 ## Reference documentation
 
-We also have [auto-generated reference documentation for the code](./code/README.md).
+We also have [auto-generated reference documentation for the code](../modules/index.html).