# Roadmap: v0.7.7 README Simplification

## Status

Planned

## Requirement

REQ-Documentation-Structure

## Context

README.md is the entry point for new users.

As RAC functionality has expanded, there is a risk that README becomes:

- CLI reference documentation
- Artifact documentation
- Roadmap history
- Architecture archive

This makes RAC harder to understand quickly.

README should explain:

> What is RAC and should I keep reading?

Detailed knowledge should live elsewhere.

## Goal

Refactor README.md into a concise project landing page.

A new user should understand RAC within one minute.

## Scope

Update README.md structure:

```text
# Requirements as Code

## What is RAC?

## Who is it for?

## Install

## Quick Start

## Supported Artifact Types

## Documentation

## Project Status
```

## Required Content

README must include:

- One sentence product description.
- Installation command.
- Minimal validation example.
- Common commands.
- Links into docs/.

Example:

```bash
rac validate requirement.md
rac inspect requirement.md
rac stats rac/
```

## Documentation Links

README shall route users to:

- docs/quickstart.md
- docs/cli.md
- docs/artifacts.md
- docs/relationships.md
- docs/repo-workflow.md
- docs/testing.md

## Remove From README

README shall not contain:

- Full CLI reference
- Complete artifact schemas
- ADR history
- Roadmap details
- Long examples
- Internal implementation notes

## Non-Goals

This release does not:

- Rewrite documentation content.
- Introduce documentation generation.
- Change packaging metadata.

## Acceptance Criteria

- README can be read in under one minute.
- README clearly explains RAC.
- README routes deeper topics into docs/.
- README remains stable as RAC grows.

## Validation

Manual:

- Read README as a first-time user.
- Confirm every deeper topic links elsewhere.

Automated:

```bash
pytest
```

## Release

Target:

v0.7.7