Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions GOVERNANCE.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This document governs project collaboration. Microsoft organization policies, th
- Community participation should be accessible without weakening quality or security.
- Public behavior and architecture should remain aligned with confirmed specifications.
- Maintainer authority comes with service responsibilities, not only merge access.
- Project direction should follow the published [Roadmap](ROADMAP.md) and its grounding strategy.
- Project direction should be discussed through public Issues, milestones, design documents, and pull requests.

## Roles

Expand All @@ -37,7 +37,7 @@ Maintainers steward the project as a whole. Their responsibilities include:
- Triaging Issues and reviewing pull requests.
- Protecting public contracts, architecture boundaries, and specification accuracy.
- Maintaining CI, releases, dependencies, security response, and repository policy.
- Keeping the Roadmap and contributor documentation current.
- Keeping contributor and project documentation current.
- Developing other contributors and sharing project knowledge.

The current maintainers are the recognized owners listed in [.github/CODEOWNERS](.github/CODEOWNERS). Repository permissions determine whether GitHub recognizes an account as a code owner.
Expand Down Expand Up @@ -66,11 +66,11 @@ Maintainers seek consensus. If material disagreement remains after reasonable di

Administrators may use repository-rule bypasses only through a pull request when the configured ruleset permits it. A pull request and auditable rationale remain required.

## Roadmap and Releases
## Project Direction and Releases

[ROADMAP.md](ROADMAP.md) communicates project direction. GitHub Issues and milestones represent committed or scheduled work; roadmap placement alone does not promise delivery.
GitHub Issues and milestones communicate proposed, committed, or scheduled work. Material strategy and priority changes should be recorded in a public Issue, design document, or pull request unless security or privacy requires private handling.

Maintainers review roadmap accuracy at least monthly and after material strategy changes. Releases are approved and published by maintainers after required validation succeeds. Release frequency depends on readiness rather than a fixed calendar.
Releases are approved and published by maintainers after required validation succeeds. Release frequency depends on readiness rather than a fixed calendar.

## Role Progression

Expand All @@ -97,4 +97,4 @@ All project participation follows the [Code of Conduct](CODE_OF_CONDUCT.md). Sec

## Governance Changes

Changes to this document require a pull request and use the project-level decision process. Governance should remain lightweight enough for the current community while making authority, responsibility, and contributor progression explicit.
Changes to this document require a pull request and use the project-level decision process. Governance should remain lightweight enough for the current community while making authority, responsibility, and contributor progression explicit.
10 changes: 3 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ See the remaining approved screenshots in [release media](docs/media/README.md).

## Five-minute quickstart

This public Web example uses [Example Domain](https://example.com/), requires an installed Chromium-family browser, and writes all project data locally. Steps 1-3 exercise the provider-free harness path. A configured Provider is only needed for AI-driven Case creation or post-run suggestions.
This public Web example uses [TodoMVC](https://todomvc.com/examples/react/dist/), requires an installed Chromium-family browser, and writes all project data locally. Steps 1-3 exercise the provider-free harness path. A configured Provider is only needed for AI-driven Case creation or post-run suggestions.

### 1. Install

Expand All @@ -106,7 +106,7 @@ Workspace root selection is exact:

### 3. Replay the public example without a planning LLM

Download the versioned [`examples/web/example-domain.fsq.yaml`](examples/web/example-domain.fsq.yaml) into the Workspace and run it:
Download the current [`examples/web/example-domain.fsq.yaml`](examples/web/example-domain.fsq.yaml) into the Workspace and run it:

```bash
mkdir -p cases/web
Expand Down Expand Up @@ -173,7 +173,7 @@ Goal ──► AI exploration ──► evidence ──► verification ──
Reviewed Case ──► deterministic replay ──► fresh evidence ─┘
```

Dynamic execution and deterministic replay share platform Harnesses and evidence contracts. The original execution result is immutable; later suggestion analysis cannot rewrite it or perform another UI execution. See the [architecture overview](docs/architecture.md).
Dynamic execution and deterministic replay share platform Harnesses and evidence contracts. The original execution result is immutable; later suggestion analysis cannot rewrite it or perform another UI execution. Implementation-level architecture and behavior are defined by the root and module `SPEC.md` files.

## Supported platforms

Expand Down Expand Up @@ -220,10 +220,6 @@ Provider configuration is stored under `~/.fsq` and shared by the CLI and local
| [FSQ Case format](docs/case-format.md) | Case structure and a validated public example |
| [Platform prerequisites](docs/platform-prerequisites.md) | Web, Android, Windows, and macOS host setup boundaries |
| [Support and stability](docs/support-and-stability.md) | Alpha scope, compatibility, privacy, and support expectations |
| [Architecture](docs/architecture.md) | Current runtime layers and ownership boundaries |
| [Release acceptance](docs/release-acceptance-checklist.md) | Maintainer release-candidate verification |
| [Directory migration guide](docs/package-directory-migration-guide.md) | Package ownership and future migration criteria |
| [Roadmap](ROADMAP.md) | Direction rather than release commitment |

## Contributing

Expand Down
5 changes: 2 additions & 3 deletions README.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ FSQ 补充而不是替代平台自动化库。Playwright、uiautomator2、pywina

## 五分钟快速开始

这个公开 Web 示例使用 [Example Domain](https://example.com/),需要已安装 Chromium 系浏览器,并且只在本地写入项目数据。AI 驱动命令还需要配置 Provider。
这个公开 Web 示例使用 [TodoMVC](https://todomvc.com/examples/react/dist/),需要已安装 Chromium 系浏览器,并且只在本地写入项目数据。AI 驱动命令还需要配置 Provider。

### 1. 安装

Expand All @@ -89,7 +89,7 @@ Workspace Root Strategy 是精确规则:

### 3. 不依赖规划 LLM,重放公开示例

把版本化的 [`examples/web/example-domain.fsq.yaml`](examples/web/example-domain.fsq.yaml) 下载到 Workspace 的 `cases/web/`,然后运行:
把当前的 [`examples/web/example-domain.fsq.yaml`](examples/web/example-domain.fsq.yaml) 下载到 Workspace 的 `cases/web/`,然后运行:

```bash
mkdir -p cases/web
Expand Down Expand Up @@ -160,7 +160,6 @@ fsq ui
| [FSQ Case format](docs/case-format.md) | Case 结构和公开示例 |
| [Platform prerequisites](docs/platform-prerequisites.md) | 平台前置条件边界 |
| [Support and stability](docs/support-and-stability.md) | Alpha 范围、兼容性、隐私和支持预期 |
| [Architecture](docs/architecture.md) | 当前运行时层级和职责边界 |

## License

Expand Down
83 changes: 0 additions & 83 deletions ROADMAP.md

This file was deleted.

3 changes: 1 addition & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,11 @@
- [Case format](case-format.md)
- [Platform prerequisites](platform-prerequisites.md)
- [Support and stability](support-and-stability.md)
- [Architecture](architecture.md)
- [v0.1.0 release notes](releases/v0.1.0.md)
- [v0.1.0 GitHub Release copy](releases/v0.1.0-github-release.md)
- [Autoplay demo page](demo.html)
- [English launch article](launch/introducing-fsq.md)
- [中文发布文章](launch/introducing-fsq.zh-CN.md)
- [Release media plan](media/README.md)

Maintainer-oriented design documents and acceptance checklists also live in this directory. Current product behavior is defined by the repository's root and module `SPEC.md` files.
Current product behavior and implementation architecture are defined by the repository's root and module `SPEC.md` files.
38 changes: 0 additions & 38 deletions docs/architecture.md

This file was deleted.

12 changes: 6 additions & 6 deletions docs/case-format.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,25 @@
# FSQ Case Format

An FSQ Case is UTF-8 YAML with the `.fsq.yaml` suffix. The current schema identifier is `fsq.ai-test/v1`.
An FSQ Case is UTF-8 YAML with the `.fsq.yaml` suffix. The current schema identifier is `fsq.ai-test/v1`. The following independent minimum example opens TodoMVC and verifies its heading:

```yaml
schemaVersion: fsq.ai-test/v1
name: Example Domain smoke test
name: TodoMVC smoke test
platform: web
---
- startBrowser
- navigateTo:
url: https://example.com/
url: https://todomvc.com/examples/react/dist/
- assertVisible:
target: Example Domain heading
target: TodoMVC heading
locator:
role: heading
name: Example Domain
name: todos
optional: false
- closeBrowser
```

The complete validated example is [`examples/web/example-domain.fsq.yaml`](../examples/web/example-domain.fsq.yaml).
For a complete recorded workflow with text entry, clicks, and final-state assertions, see [`examples/web/example-domain.fsq.yaml`](../examples/web/example-domain.fsq.yaml).

The first YAML document contains metadata. The optional second document contains ordered commands. Unknown fields, unsupported schema versions, malformed commands, and platform mismatches fail validation.

Expand Down
10 changes: 5 additions & 5 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Getting Started

This guide takes a new user from installation to a deterministic Web run against the public [Example Domain](https://example.com/). FSQ v0.1.0 is alpha software; review [support and stability](support-and-stability.md) before production adoption.
This guide takes a new user from installation to a deterministic Web run against public [TodoMVC](https://todomvc.com/examples/react/dist/). FSQ v0.1.0 is alpha software; review [support and stability](support-and-stability.md) before production adoption.

## Prerequisites

Expand Down Expand Up @@ -32,17 +32,17 @@ An empty current directory becomes the Workspace root. When the current director

## Run the public deterministic example

Download the versioned [`examples/web/example-domain.fsq.yaml`](../examples/web/example-domain.fsq.yaml) into `cases/web/` in the Workspace, then run:
Download the current [`examples/web/example-domain.fsq.yaml`](../examples/web/example-domain.fsq.yaml) into `cases/web/` in the Workspace, then run:

```bash
mkdir -p cases/web
curl --fail --location --output cases/web/example-domain.fsq.yaml \
https://raw.githubusercontent.com/microsoft/FSQ/v0.1.0/examples/web/example-domain.fsq.yaml
https://raw.githubusercontent.com/microsoft/FSQ/main/examples/web/example-domain.fsq.yaml
fsq case test --platform web cases/web/example-domain.fsq.yaml
fsq runs list --platform web
```

The Case starts the configured browser, opens `https://example.com/`, verifies its public heading, and closes the browser. Evidence is stored below `.fsq/runs/web/<run-id>/`.
The Case starts the configured browser, opens TodoMVC, adds two tasks, completes the first task, filters to active tasks, verifies the expected visible state, and closes the browser. Evidence is stored below `.fsq/runs/web/<run-id>/`.

## Configure AI exploration

Expand Down Expand Up @@ -86,4 +86,4 @@ The installed frontend is served locally on `127.0.0.1:8879` by default.
- Review [platform prerequisites](platform-prerequisites.md).
- Learn the [Case format](case-format.md).
- See the [CLI reference](cli-reference.md).
- Read the [architecture overview](architecture.md).
- Review the root and module `SPEC.md` files for implementation-level architecture and behavior contracts.
Loading
Loading