docs: pandoc-based site and v0.1.0 groundwork (#5)

* chore(prose): remove em-dashes from config files

* chore(prose): remove em-dashes from android sdk config

* docs(spec-api): remove em-dash from README

* fix(doctor): reword sidecar-jar error without em-dash

* test(sidecar): reword assertion message without em-dash

* docs: add CLAUDE.md with project conventions

* build: add docs target for pandoc site

* docs(site): add pandoc template and stylesheet

* docs(site): add pandoc build script

* docs(site): add landing pages

* docs(manual): add getting-started

* docs(manual): add writing-specs

* docs(manual): add runs

* docs(manual): add cli reference

* docs(dev): add design principles

* docs(dev): add architecture

* ci: deploy docs site to github pages

* docs: rewrite README as entry point to docs site
This commit is contained in:
pj authored and GitHub committed 2026-04-18 14:00:57 +07:00
1 parent a74d9fbeae
commit e62319e916
25 files changed
+920 -56

No files matched your search

+8 -44
View File
@@ -1,51 +1,15 @@
# uatu
Testing framework and spec in ts/js used for blackbox testing and property based testing
Autonomous property-based testing for mobile apps. Specs in TypeScript. Core in Go. Drives the app under test through Maestro and an in-app SDK.
> Alpha. Android emulator only. Full scope in the [v0.1.0 roadmap](https://github.com/priyanshujain/uatu/issues/4).
## Supported Platforms
- android
- ios
## Docs
## Install
Everything is in the docs site: **[priyanshujain.github.io/uatu](https://priyanshujain.github.io/uatu/)**
### CLI
Or browse the sources in [`docs/`](./docs).
Download the platform tarball from [GitHub Releases](https://github.com/priyanshujain/uatu/releases/latest):
```sh
# macOS arm64
curl -L https://github.com/priyanshujain/uatu/releases/latest/download/uatu_<version>_darwin_arm64.tar.gz | tar xz
# Linux amd64
curl -L https://github.com/priyanshujain/uatu/releases/latest/download/uatu_<version>_linux_amd64.tar.gz | tar xz
./uatu version
```
Pre-built for `darwin/arm64`, `darwin/amd64`, `linux/amd64`, `linux/arm64`.
### Spec API (npm)
```sh
npm install --save-dev @uatu/spec
```
```ts
import { extract, always, actions } from "@uatu/spec";
```
### Android SDK (Maven Central)
```kotlin
// settings.gradle.kts
dependencyResolutionManagement {
repositories {
mavenCentral()
}
}
// app/build.gradle.kts
dependencies {
implementation("io.github.priyanshujain:sdk-android:<version>")
}
```
- [Getting started](./docs/manual/getting-started.md)
- [Writing specs](./docs/manual/writing-specs.md)
- [Architecture](./docs/development/architecture.md)