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
57 changes: 57 additions & 0 deletions docs/superpowers/specs/2026-08-16-resq-profile-readme-design.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
# RESQ Organization Profile README Design

## Goal

Replace the flat organization profile with a current, developer-first launchpad. A reader should understand what RESQ builds, enter the reproducible development environment, inspect the live system, and find the relevant repository without working through a product pitch.

## Audience And Primary Action

The primary audience is developers and contributors. The primary call to action is the full onboarding installer at `get.resq.software`; live visualization, documentation, and research are adjacent secondary actions.

## Information Hierarchy

The README will use this order:

1. RESQ identity and a concise, supportable platform position.
2. Developer actions: Get Started, Live Viz, Docs, and Research.
3. The current one-command onboarding flow and its delivery guarantees.
4. The four live surfaces: Research, Viz, Docs, and Design.
5. A compact platform map connecting packages, SDKs, coordination infrastructure, simulation, and the operator view.
6. The public repository catalog, grouped by role.
7. Contribution guidance, organization standards, contact, and license.

## Visual Treatment

- Use GitHub-native Markdown with restrained HTML where it improves alignment.
- Center the existing RESQ mark and title without using the outdated 21 MB banner.
- Use flat-square badges for primary destinations and the license.
- Use one compact Mermaid diagram as the visual manual.
- Present Research, Viz, Docs, and Design in a four-column surface strip.
- Group repositories under Experience, SDKs, Runtime, and Foundation rather than presenting one flat language list.
- Keep headings short and avoid emoji-heavy presentation, nested cards, generated artwork, and pitch-deck sections.

The result must remain legible in GitHub light and dark themes and must not depend on custom CSS or JavaScript.

## Content Contract

Repository names and descriptions will be based on the current public GitHub organization state. Include the ten public, non-archived, non-fork product and tooling repositories. Exclude the `.github` meta-repository and the `ardupilot` fork.

The installer section will describe the current `dev` behavior: GitHub authentication, Nix-based reproducible tooling, repository selection, CLI and hook setup, immutable version routes, and pinned, hash-verified delivery. It must distinguish integrity checks from independent proof of origin.

Product copy must remain concise and supportable from public repositories and live RESQ surfaces. Investor claims and unsupported performance, compliance, or security claims do not belong in the organization profile.

## Repository Groups

- **Experience:** `viz`, `npm`, `docs`
- **SDKs:** `dotnet-sdk`, `pypi`
- **Runtime:** `crates`, `programs`
- **Foundation:** `dotnet`, `vcpkg`, `dev`

## Verification

- Confirm every linked RESQ URL responds successfully.
- Re-query public GitHub repositories and verify each eligible repository appears exactly once.
- Validate Markdown structure and embedded HTML balance.
- Validate the Mermaid diagram syntax where local tooling permits.
- Review rendered content for stale names, installer behavior, and unsupported claims.
- Inspect the final diff to ensure unrelated workspace changes are untouched.
119 changes: 86 additions & 33 deletions profile/README.md
Original file line number Diff line number Diff line change
@@ -1,49 +1,102 @@
<div align="center">
<h2>resq-software</h2>
<p>Resilient infrastructure for autonomous systems when traditional networks fail.</p>
<br/>
<img src="https://raw.githubusercontent.com/resq-software/.github/main/assets/resq-icon-color.svg" alt="ResQ Systems mark" width="88">
<h1>ResQ Systems</h1>
<p><strong>Software for autonomous disaster response.</strong></p>
<p>Resilient coordination, simulation, and operator tooling for autonomous systems working through degraded networks and infrastructure.</p>

[![Docs](https://img.shields.io/badge/docs-docs.resq.software-0ea5e9?style=flat-square)](https://docs.resq.software)
[![Website](https://img.shields.io/badge/site-resq.software-0ea5e9?style=flat-square)](https://resq.software)
[![License](https://img.shields.io/badge/license-Apache--2.0-blue?style=flat-square)](https://github.com/resq-software/.github/blob/main/LICENSE)
[![Get started](https://img.shields.io/badge/get_started-get.resq.software-238636?style=flat-square&logo=gnubash&logoColor=white)](https://get.resq.software)
[![Live visualization](https://img.shields.io/badge/live_viz-viz.resq.software-0e7490?style=flat-square)](https://viz.resq.software)
[![Documentation](https://img.shields.io/badge/docs-docs.resq.software-2563eb?style=flat-square)](https://docs.resq.software)
[![Research](https://img.shields.io/badge/research-research.resq.software-7c3aed?style=flat-square)](https://research.resq.software)
[![License](https://img.shields.io/badge/license-Apache--2.0-475569?style=flat-square)](https://github.com/resq-software/.github/blob/main/LICENSE)
</div>

---
## Start building

ResQ is a mission-critical autonomous platform for decentralized coordination in disaster response and emergency logistics — designed to operate when traditional networks fail.
Bootstrap a reproducible RESQ development environment:

## Ecosystem
```bash
curl -fsSL https://get.resq.software | sh
```

| Repository | What it is | Language |
|-----------|-----------|----------|
| [npm](https://github.com/resq-software/npm) | React component library (shadcn/ui + Radix + Tailwind v4) | TypeScript |
| [crates](https://github.com/resq-software/crates) | Rust CLI/TUI toolset for drone ops (ships the `resq` binary) | Rust |
| [pypi](https://github.com/resq-software/pypi) | FastMCP server + DSA utilities | Python |
| [dotnet-sdk](https://github.com/resq-software/dotnet-sdk) | .NET typed clients + blockchain anchoring | C# |
| [programs](https://github.com/resq-software/programs) | Solana Anchor on-chain programs | Rust |
| [vcpkg](https://github.com/resq-software/vcpkg) | C++ vcpkg libraries | C++ |
| [viz](https://github.com/resq-software/viz) | .NET visualization library | C# |
| [docs](https://github.com/resq-software/docs) | Documentation (Mintlify) | MDX |
| [dev](https://github.com/resq-software/dev) | One-command developer setup + canonical git hooks | Shell |
The onboarding flow authenticates with GitHub, installs a pinned Nix toolchain, lets you choose a repository, enters its development environment, and configures the `resq` CLI and canonical git hooks.

## Get started
`get.resq.software` serves pinned, SHA-256-verified artifacts and exposes immutable version routes for provisioning. Those checks protect the GitHub-to-Worker delivery path and detect corrupted downloads; they are not an independent signature or proof of origin. See [`resq-software/dev`](https://github.com/resq-software/dev) for version pinning, unattended setup, digest verification, and the complete trust model.

Install the `resq` CLI and onboard a repo in one line:
## Explore the system

```bash
curl -fsSL https://get.resq.software | sh
```
<table>
<tr>
<td width="25%" valign="top">
<a href="https://research.resq.software"><strong>Research</strong></a><br>
Working papers, technical notes, and field reports on emergency-response software.
</td>
<td width="25%" valign="top">
<a href="https://viz.resq.software"><strong>Viz</strong></a><br>
Live 3D common operating picture for simulated multi-agency autonomous response.
</td>
<td width="25%" valign="top">
<a href="https://docs.resq.software"><strong>Docs</strong></a><br>
Operations manual, platform concepts, integration guides, and API references.
</td>
<td width="25%" valign="top">
<a href="https://design.resq.software"><strong>Design</strong></a><br>
Component library and engineering design system used across RESQ interfaces.
</td>
</tr>
</table>

This installs a SHA256-verified `resq` binary (with a `cargo install --git` fallback), optionally clones an org repo, and drops the canonical git hooks — copyright, secrets, polyglot format, audit — into it.
## Platform map

Prefer to read before piping to a shell:
```mermaid
flowchart LR
Foundation["Packages & building blocks<br/>npm · dotnet · vcpkg"]
Tools["SDKs & developer tools<br/>dotnet-sdk · pypi · crates"]
Trust["Decentralized coordination<br/>programs"]
Operations["Simulation & operations<br/>viz"]

```bash
curl -fsSL https://get.resq.software -o install-resq.sh
less install-resq.sh
sh install-resq.sh
Foundation --> Tools
Tools --> Trust
Tools --> Operations
Trust --> Operations
```

## Links
## Public repositories

### Experience

| Repository | What it provides | Stack |
| :--- | :--- | :--- |
| [`viz`](https://github.com/resq-software/viz) | Live 3D coordination view with mesh topology, hazard fusion, telemetry, and multi-agency simulation | TypeScript, Three.js, .NET |
| [`npm`](https://github.com/resq-software/npm) | Shared UI, mapping, telemetry, security, analytics, and foundational TypeScript packages | TypeScript, React |
| [`docs`](https://github.com/resq-software/docs) | Official operations, platform, integration, and API documentation | MDX, Mintlify |

### SDKs

| Repository | What it provides | Stack |
| :--- | :--- | :--- |
| [`dotnet-sdk`](https://github.com/resq-software/dotnet-sdk) | Typed clients, protocol contracts, blockchain anchoring, and simulation harnesses | C#, Protobuf |
| [`pypi`](https://github.com/resq-software/pypi) | FastMCP server exposing digital-twin, drone-coordination, and incident-response capabilities to AI clients | Python, FastMCP |

### Runtime

| Repository | What it provides | Stack |
| :--- | :--- | :--- |
| [`crates`](https://github.com/resq-software/crates) | The `resq` CLI/TUI workspace for repository automation, diagnostics, deployment, and operations | Rust |
| [`programs`](https://github.com/resq-software/programs) | On-chain programs for decentralized airspace management and autonomous delivery coordination | Rust, Solana Anchor |

### Foundation

| Repository | What it provides | Stack |
| :--- | :--- | :--- |
| [`dotnet`](https://github.com/resq-software/dotnet) | Reusable building blocks for Clean and Hexagonal .NET architectures | C# |
| [`vcpkg`](https://github.com/resq-software/vcpkg) | C++ libraries and foundational data structures for robotics software | C++17, CMake |
| [`dev`](https://github.com/resq-software/dev) | Reproducible developer onboarding, pinned installers, and canonical repository hooks | Shell, PowerShell, Nix |

## Contribute

Start with the repository's `AGENTS.md` for its architecture and local commands, then read the organization-wide [contribution guide](https://github.com/resq-software/.github/blob/main/CONTRIBUTING.md) and [engineering standards](https://github.com/resq-software/.github/tree/main/docs/standards). Security reports follow the [coordinated disclosure policy](https://github.com/resq-software/.github/blob/main/SECURITY.md).

Questions about the platform or an integration? Contact [contact@resq.software](mailto:contact@resq.software).

[📖 Docs](https://docs.resq.software) · [🌐 Website](https://resq.software) · [🤝 Contributing](https://github.com/resq-software/.github/blob/main/CONTRIBUTING.md)
Copyright 2026 ResQ Systems, Inc. Public RESQ projects are individually licensed; organization defaults are available under [Apache License 2.0](https://github.com/resq-software/.github/blob/main/LICENSE).
Loading