docs: Add initial language guide and api docs

README.md

@@ -8,4 +8,7 @@ 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](./docs/README.md)
+## Documentation
+
+ - [Language Guide](docs/language-guide.md)
+ - [API Docs](docs/api/README.md)

docs/api/README.md

@@ -0,0 +1,77 @@
+**@algorandfoundation/algorand-typescript**
+
+***
+
+# @algorandfoundation/algorand-typescript
+
+## Namespaces
+
+- [arc4](namespaces/arc4/README.md)
+- [gtxn](namespaces/gtxn/README.md)
+- [itxn](namespaces/itxn/README.md)
+- [op](namespaces/op/README.md)
+
+## Enumerations
+
+- [OpUpFeeSource](enumerations/OpUpFeeSource.md)
+- [TransactionType](enumerations/TransactionType.md)
+
+## Classes
+
+- [BaseContract](classes/BaseContract.md)
+- [LogicSig](classes/LogicSig.md)
+- [MutableArray](classes/MutableArray.md)
+
+## Interfaces
+
+- [BytesBacked](interfaces/BytesBacked.md)
+
+## Type Aliases
+
+- [Account](type-aliases/Account.md)
+- [Application](type-aliases/Application.md)
+- [Asset](type-aliases/Asset.md)
+- [biguint](type-aliases/biguint.md)
+- [BigUintCompat](type-aliases/BigUintCompat.md)
+- [Box](type-aliases/Box.md)
+- [BoxMap](type-aliases/BoxMap.md)
+- [BoxRef](type-aliases/BoxRef.md)
+- [bytes](type-aliases/bytes.md)
+- [BytesCompat](type-aliases/BytesCompat.md)
+- [CompileContractOptions](type-aliases/CompileContractOptions.md)
+- [CompiledContract](type-aliases/CompiledContract.md)
+- [CompiledLogicSig](type-aliases/CompiledLogicSig.md)
+- [CompileLogicSigOptions](type-aliases/CompileLogicSigOptions.md)
+- [GlobalState](type-aliases/GlobalState.md)
+- [GlobalStateOptions](type-aliases/GlobalStateOptions.md)
+- [LocalState](type-aliases/LocalState.md)
+- [LocalStateForAccount](type-aliases/LocalStateForAccount.md)
+- [StringCompat](type-aliases/StringCompat.md)
+- [uint64](type-aliases/uint64.md)
+- [Uint64Compat](type-aliases/Uint64Compat.md)
+
+## Functions
+
+- [Account](functions/Account.md)
+- [Application](functions/Application.md)
+- [assert](functions/assert.md)
+- [assertMatch](functions/assertMatch.md)
+- [Asset](functions/Asset.md)
+- [BigUint](functions/BigUint.md)
+- [Box](functions/Box.md)
+- [BoxMap](functions/BoxMap.md)
+- [BoxRef](functions/BoxRef.md)
+- [Bytes](functions/Bytes.md)
+- [compile](functions/compile.md)
+- [contract](functions/contract.md)
+- [emit](functions/emit.md)
+- [ensureBudget](functions/ensureBudget.md)
+- [err](functions/err.md)
+- [GlobalState](functions/GlobalState.md)
+- [LocalState](functions/LocalState.md)
+- [log](functions/log.md)
+- [logicsig](functions/logicsig.md)
+- [match](functions/match.md)
+- [TemplateVar](functions/TemplateVar.md)
+- [Uint64](functions/Uint64.md)
+- [urange](functions/urange.md)

docs/api/classes/BaseContract.md

@@ -0,0 +1,55 @@
+[**@algorandfoundation/algorand-typescript**](../README.md)
+
+***
+
+[@algorandfoundation/algorand-typescript](../README.md) / BaseContract
+
+# Class: `abstract` BaseContract
+
+Defined in: [packages/algo-ts/src/base-contract.ts:5](https://github.com/algorandfoundation/puya-ts/blob/5bdb536fcbeffa6fe079b274d09cae785c8fb7b7/packages/algo-ts/src/base-contract.ts#L5)
+
+## Extended by
+
+- [`Contract`](../namespaces/arc4/classes/Contract.md)
+
+## Constructors
+
+### new BaseContract()
+
+> **new BaseContract**(): [`BaseContract`](BaseContract.md)
+
+#### Returns
+
+[`BaseContract`](BaseContract.md)
+
+## Properties
+
+### isArc4
+
+> `static` **isArc4**: `boolean` = `false`
+
+Defined in: [packages/algo-ts/src/base-contract.ts:6](https://github.com/algorandfoundation/puya-ts/blob/5bdb536fcbeffa6fe079b274d09cae785c8fb7b7/packages/algo-ts/src/base-contract.ts#L6)
+
+## Methods
+
+### approvalProgram()
+
+> `abstract` **approvalProgram**(): `boolean` \| [`uint64`](../type-aliases/uint64.md)
+
+Defined in: [packages/algo-ts/src/base-contract.ts:8](https://github.com/algorandfoundation/puya-ts/blob/5bdb536fcbeffa6fe079b274d09cae785c8fb7b7/packages/algo-ts/src/base-contract.ts#L8)
+
+#### Returns
+
+`boolean` \| [`uint64`](../type-aliases/uint64.md)
+
+***
+
+### clearStateProgram()
+
+> **clearStateProgram**(): `boolean` \| [`uint64`](../type-aliases/uint64.md)
+
+Defined in: [packages/algo-ts/src/base-contract.ts:9](https://github.com/algorandfoundation/puya-ts/blob/5bdb536fcbeffa6fe079b274d09cae785c8fb7b7/packages/algo-ts/src/base-contract.ts#L9)
+
+#### Returns
+
+`boolean` \| [`uint64`](../type-aliases/uint64.md)

docs/api/classes/LogicSig.md

@@ -0,0 +1,31 @@
+[**@algorandfoundation/algorand-typescript**](../README.md)
+
+***
+
+[@algorandfoundation/algorand-typescript](../README.md) / LogicSig
+
+# Class: `abstract` LogicSig
+
+Defined in: [packages/algo-ts/src/logic-sig.ts:4](https://github.com/algorandfoundation/puya-ts/blob/5bdb536fcbeffa6fe079b274d09cae785c8fb7b7/packages/algo-ts/src/logic-sig.ts#L4)
+
+## Constructors
+
+### new LogicSig()
+
+> **new LogicSig**(): [`LogicSig`](LogicSig.md)
+
+#### Returns
+
+[`LogicSig`](LogicSig.md)
+
+## Methods
+
+### program()
+
+> `abstract` **program**(): `boolean` \| [`uint64`](../type-aliases/uint64.md)
+
+Defined in: [packages/algo-ts/src/logic-sig.ts:5](https://github.com/algorandfoundation/puya-ts/blob/5bdb536fcbeffa6fe079b274d09cae785c8fb7b7/packages/algo-ts/src/logic-sig.ts#L5)
+
+#### Returns
+
+`boolean` \| [`uint64`](../type-aliases/uint64.md)