steve
574370e8d1
BREAKING: Remove Dockerfile.rocm, compose.rocm.yaml, and ROCm image build/push from the release pipeline. Remove AMD quick-start and ROCm references from README and DEVELOPER docs. Update docker-deployment and developer-docs specs to reflect CPU + NVIDIA only. The ROCm variant added significant complexity (4.2GB torch wheel, >20GB container) with limited usage. Users on AMD GPUs should stay on engine v3.2.x or switch to CPU mode. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
51 lines
2.4 KiB
Markdown
51 lines
2.4 KiB
Markdown
### Requirement: DEVELOPER.md exists at repo root
|
|
The repository SHALL have a `DEVELOPER.md` file at the project root containing all developer-facing documentation.
|
|
|
|
#### Scenario: File exists
|
|
- **WHEN** a developer navigates to the repository root
|
|
- **THEN** a `DEVELOPER.md` file SHALL be present
|
|
|
|
### Requirement: DEVELOPER.md contains build-from-source instructions
|
|
DEVELOPER.md SHALL contain instructions for building both the engine and client from source.
|
|
|
|
#### Scenario: Engine build from source
|
|
- **WHEN** a developer reads DEVELOPER.md
|
|
- **THEN** it SHALL include instructions for starting the engine from source using compose files (NVIDIA and CPU)
|
|
|
|
#### Scenario: Client build from source
|
|
- **WHEN** a developer reads DEVELOPER.md
|
|
- **THEN** it SHALL include instructions for building the client binary from source using `make build` and `make all`
|
|
|
|
### Requirement: DEVELOPER.md contains release process
|
|
DEVELOPER.md SHALL document the release process for both client and engine, including release scripts, version bumping, and Docker image tagging.
|
|
|
|
#### Scenario: Client release documentation
|
|
- **WHEN** a developer reads DEVELOPER.md
|
|
- **THEN** it SHALL include `release-client.sh` usage with flag options (--gitea, --github, --minor, --no-increment, --dry-run)
|
|
|
|
#### Scenario: Engine release documentation
|
|
- **WHEN** a developer reads DEVELOPER.md
|
|
- **THEN** it SHALL include `release-engine.sh` usage with flag options and Docker image tag conventions
|
|
|
|
#### Scenario: Version checking
|
|
- **WHEN** a developer reads DEVELOPER.md
|
|
- **THEN** it SHALL include how to check client and engine versions
|
|
|
|
### Requirement: README.md excludes developer-only content
|
|
README.md SHALL NOT contain build-from-source instructions, release processes, or developer-only notes.
|
|
|
|
#### Scenario: No from-source build steps in README
|
|
- **WHEN** a user reads README.md
|
|
- **THEN** there SHALL be no "From source" subsections under engine or client installation
|
|
|
|
#### Scenario: No release section in README
|
|
- **WHEN** a user reads README.md
|
|
- **THEN** there SHALL be no "Building and releasing" section
|
|
|
|
### Requirement: README.md cross-references DEVELOPER.md
|
|
README.md SHALL include a link to DEVELOPER.md for users who want to build from source or contribute.
|
|
|
|
#### Scenario: Developer link in quick start
|
|
- **WHEN** a user reads the Quick Start section of README.md
|
|
- **THEN** there SHALL be a note pointing to DEVELOPER.md for building from source
|