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
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: Bug report
about: Report a bug or unexpected behavior in AgentUX
about: Report a bug or unexpected behavior in BiModal Design
title: '[BUG] '
labels: bug
assignees: ''
Expand Down Expand Up @@ -28,7 +28,7 @@ Steps to reproduce the behavior:

## Environment

- **AgentUX Version**: [e.g., 0.1.0]
- **BiModal Design Version**: [e.g., 0.1.0]
- **Node.js Version**: [e.g., 16.14.0]
- **Operating System**: [e.g., macOS 13.0, Ubuntu 22.04, Windows 11]
- **Tool Used**: [e.g., fr1-validator, compliance-audit, agent-simulator]
Expand Down Expand Up @@ -64,5 +64,5 @@ Paste any error messages or unexpected output here
## Checklist

- [ ] I have searched existing issues to avoid duplicates
- [ ] I have tested with the latest version of AgentUX
- [ ] I have tested with the latest version of BiModal Design
- [ ] I have included all requested information above
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
blank_issues_enabled: true
contact_links:
- name: GitHub Discussions
url: https://github.com/jgoldfoot/AgentUX/discussions
url: https://github.com/jgoldfoot/BiModal Design/discussions
about: Ask questions and discuss ideas with the community
- name: Security Vulnerability
url: https://github.com/jgoldfoot/AgentUX/security/policy
url: https://github.com/jgoldfoot/BiModal Design/security/policy
about: Report security vulnerabilities privately (do not use public issues)
- name: Email Contact
url: mailto:[email protected]
Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: Feature request
about: Suggest a new feature or enhancement for AgentUX
about: Suggest a new feature or enhancement for BiModal Design
title: '[FEATURE] '
labels: enhancement
assignees: ''
Expand Down Expand Up @@ -32,7 +32,7 @@ assignees: ''

## Benefits

## <!-- Who would benefit from this feature? How would it improve AgentUX? -->
## <!-- Who would benefit from this feature? How would it improve BiModal Design? -->

-

Expand Down
8 changes: 4 additions & 4 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@

## For AI Coding Agents

This file helps AI agents understand how to contribute to AgentUX, a framework
This file helps AI agents understand how to contribute to BiModal Design, a framework
for building dual-mode interfaces that work for both humans and AI agents.

---

## Project Overview

**AgentUX** addresses a critical gap: ~80% of AI agents make simple HTTP
**BiModal Design** addresses a critical gap: ~80% of AI agents make simple HTTP
requests without JavaScript execution, making client-side rendered applications
invisible to them.

Expand All @@ -19,15 +19,15 @@ the server's initial HTML response.
**Key Metrics:**

- Conventional interfaces: 72% human success vs. 12% agent success
- AgentUX-optimized interfaces: 42-70% agent success
- BiModal Design-optimized interfaces: 42-70% agent success
- Improvement: 40-75% better agent task completion

---

## Repository Structure

```
AgentUX/
BiModal Design/
├── README.md # Main documentation
├── AGENTS.md # This file
├── docs/ # White papers and guides
Expand Down
12 changes: 6 additions & 6 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## [0.1.0] - 2025-10-23

### Added
- Initial public release of AgentUX framework
- Initial public release of BiModal Design framework
- Core documentation:
- README.md with quick start guide
- White paper v2.1 with comprehensive framework specification
Expand All @@ -37,9 +37,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Tools
- FR1 Validator - Test initial payload accessibility
- FR1 Checker - Advanced compliance checking with batch processing
- Compliance Auditor - Comprehensive AgentUX assessment across 7 foundational requirements
- Compliance Auditor - Comprehensive BiModal Design assessment across 7 foundational requirements
- Agent Simulator - Simulate different AI agent profiles and capabilities
- AgentUX CLI - Unified command-line interface for all tools
- BiModal Design CLI - Unified command-line interface for all tools

### Examples
- Client-side rendering failure example (CSR)
Expand Down Expand Up @@ -80,7 +80,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

### Version 0.1.0 - Initial Public Release

This is the first public release of AgentUX, a comprehensive framework for building interfaces that work for both humans and AI agents. The framework addresses a critical gap: approximately 80% of AI agents use simple HTTP requests without JavaScript execution, making client-side rendered applications completely invisible to them.
This is the first public release of BiModal Design, a comprehensive framework for building interfaces that work for both humans and AI agents. The framework addresses a critical gap: approximately 80% of AI agents use simple HTTP requests without JavaScript execution, making client-side rendered applications completely invisible to them.

**Key Highlights:**
- Complete framework specification based on peer-reviewed research
Expand Down Expand Up @@ -136,5 +136,5 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for how to get involved. We're especially

---

[Unreleased]: https://github.com/jgoldfoot/AgentUX/compare/v0.1.0...HEAD
[0.1.0]: https://github.com/jgoldfoot/AgentUX/releases/tag/v0.1.0
[Unreleased]: https://github.com/jgoldfoot/BiModal Design/compare/v0.1.0...HEAD
[0.1.0]: https://github.com/jgoldfoot/BiModal Design/releases/tag/v0.1.0
16 changes: 8 additions & 8 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# AgentUX Community Code of Conduct
# BiModal Design Community Code of Conduct

## Our Commitment

The AgentUX project is dedicated to building interfaces that work for both
The BiModal Design project is dedicated to building interfaces that work for both
humans and AI agents. We are committed to creating an inclusive, respectful, and
collaborative community where everyone can contribute to advancing agent-human
interface design regardless of experience level, background, or identity.
Expand All @@ -21,7 +21,7 @@ Examples of behavior that contributes to a positive environment include:

- **Constructive Collaboration**: Providing thoughtful feedback on designs,
code, and documentation
- **Knowledge Sharing**: Helping others understand AgentUX principles and
- **Knowledge Sharing**: Helping others understand BiModal Design principles and
implementation techniques
- **Inclusive Communication**: Using welcoming and inclusive language that helps
newcomers feel welcome
Expand Down Expand Up @@ -58,7 +58,7 @@ This Code of Conduct applies within all community spaces, including:
- GitHub repositories, issues, and pull requests
- Documentation and example code
- Community forums and discussions
- Social media interactions related to AgentUX
- Social media interactions related to BiModal Design
- Events, conferences, and meetups (virtual or in-person)
- Private communications when they relate to community activities

Expand Down Expand Up @@ -125,7 +125,7 @@ individual, or aggression toward or disparagement of classes of individuals.
**Consequence**: A permanent ban from any sort of public interaction within the
community.

## AgentUX-Specific Guidelines
## BiModal Design-Specific Guidelines

### Technical Discussions

Expand Down Expand Up @@ -163,7 +163,7 @@ community.
We recognize valuable community contributions including:

- **High-Quality Bug Reports**: Detailed reports that help improve the framework
- **Documentation Improvements**: Making AgentUX more accessible through better
- **Documentation Improvements**: Making BiModal Design more accessible through better
docs
- **Educational Content**: Blog posts, tutorials, and talks that help others
learn
Expand All @@ -182,7 +182,7 @@ as initial reports.

This Code of Conduct is adapted from the
[Contributor Covenant](https://www.contributor-covenant.org/), version 2.1, and
includes AgentUX-specific guidelines to support our unique focus on dual-mode
includes BiModal Design-specific guidelines to support our unique focus on dual-mode
interface design.

For answers to common questions about this code of conduct, see the FAQ at
Expand All @@ -195,6 +195,6 @@ https://www.contributor-covenant.org/translations.
**Last Updated**: October 2025
**Next Review**: April 2026

By participating in the AgentUX community, you agree to abide by this Code of
By participating in the BiModal Design community, you agree to abide by this Code of
Conduct and help create a positive environment for everyone working to improve
agent-human interface design.
16 changes: 8 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contributing to AgentUX
# Contributing to BiModal Design

Thank you for your interest in contributing to AgentUX! This framework aims to
Thank you for your interest in contributing to BiModal Design! This framework aims to
make the web more accessible to both humans and AI agents, and we welcome
contributions from developers, designers, researchers, and accessibility
experts.
Expand Down Expand Up @@ -36,12 +36,12 @@ behavior to [[email protected]](mailto:[email protected]).
1. **Fork the repository** on GitHub
2. **Clone your fork** locally:
```bash
git clone https://github.com/YOUR-USERNAME/AgentUX.git
cd AgentUX
git clone https://github.com/YOUR-USERNAME/BiModal Design.git
cd BiModal Design
```
3. **Set up the original repo as upstream**:
```bash
git remote add upstream https://github.com/jgoldfoot/AgentUX.git
git remote add upstream https://github.com/jgoldfoot/BiModal Design.git
```
4. **Install tool dependencies**:
```bash
Expand Down Expand Up @@ -85,7 +85,7 @@ We welcome many types of contributions:

### 🧪 **Research & Testing**

- Test AgentUX on real websites
- Test BiModal Design on real websites
- Validate framework claims with data
- Contribute case studies
- User experience research
Expand Down Expand Up @@ -261,6 +261,6 @@ Apache License 2.0, the same license as the project.

Don't hesitate to ask! We're here to help make your contribution successful.
Whether you're fixing a typo or proposing a major feature, every contribution
makes AgentUX better for everyone.
makes BiModal Design better for everyone.

**Welcome to the AgentUX community!** 🎉
**Welcome to the BiModal Design community!** 🎉
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# **AgentUX**
# **BiModal Design**

> **A design framework for building dual-mode interfaces that work optimally for both humans and AI agents.**

Expand Down Expand Up @@ -29,9 +29,9 @@

## 🧠 Overview

**AgentUX** defines best practices and validation tools for creating **dual-mode interfaces** — designs that remain equally functional for **human users** and **AI agents**.
**BiModal Design** defines best practices and validation tools for creating **dual-mode interfaces** — designs that remain equally functional for **human users** and **AI agents**.

As agentic technologies proliferate, ensuring mutual interpretability between people and machines becomes essential. AgentUX bridges that gap through **semantic design standards**, **agent-readable metadata**, and **progressive rendering strategies**.
As agentic technologies proliferate, ensuring mutual interpretability between people and machines becomes essential. BiModal Design bridges that gap through **semantic design standards**, **agent-readable metadata**, and **progressive rendering strategies**.

---

Expand All @@ -51,7 +51,7 @@ This invisibility undermines discoverability, automation, and LLM-driven workflo

## ✅ The Solution

AgentUX establishes **foundational requirements, design principles, and validation tools** to ensure both humans and agents perceive meaningful structure.
BiModal Design establishes **foundational requirements, design principles, and validation tools** to ensure both humans and agents perceive meaningful structure.

### 🏗️ Foundational Requirements

Expand All @@ -68,8 +68,8 @@ AgentUX establishes **foundational requirements, design principles, and validati

### 🔧 Validation Tools

- **FR-1 Checker** — verify server payload accessibility
- **Compliance Auditor** — full AgentUX rule suite
- **FR-1 Checker** — verify server payload accessibility
- **Compliance Auditor** — full BiModal Design rule suite
- **CI/CD Integration** — continuous validation

---
Expand All @@ -85,7 +85,7 @@ curl -s https://your-site.com | grep -E '<(nav|main|h1|form)'
✅ Expect visible semantic HTML.
❌ Empty `<div id="root"></div>` means content is invisible to agents.

### 2. Run AgentUX Validation
### 2. Run BiModal Design Validation
```bash
cd tools/validators
node fr1-checker.js https://your-site.com --verbose
Expand Down Expand Up @@ -114,8 +114,8 @@ node fr1-checker.js https://your-site.com --verbose

## 📊 Key Research Findings

| Metric | Conventional Interfaces | AgentUX-Optimized | Improvement |
|--------|------------------------|-------------------|-------------|
| Metric | Conventional Interfaces | BiModal Design-Optimized | Improvement |
|--------|------------------------|--------------------------|-------------|
| Human Task Success | 72% | — | — |
| Agent Task Success | 12% | 42–70% | +40–75% |
| Agent Completion Rate | — | +40–75% | Significant |
Expand Down Expand Up @@ -175,8 +175,8 @@ Refer to the [Contributing Guidelines](CONTRIBUTING.md) for review standards and
## 🧰 Development Setup
```bash
# Clone the repository
git clone https://github.com/jgoldfoot/AgentUX.git
cd AgentUX
git clone https://github.com/jgoldfoot/BiModalDesign.git
cd BiModalDesign

# Install dependencies
cd tools/validators
Expand Down Expand Up @@ -214,4 +214,4 @@ Senior Director of Product Design | AI + UX Researcher

---

**AgentUX** — Designing the future of human-AI collaboration, one interface at a time.
**BiModal Design** — Designing the future of human-AI collaboration, one interface at a time.
6 changes: 3 additions & 3 deletions SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ We release patches for security vulnerabilities in the following versions:

## Reporting a Vulnerability

The AgentUX team takes security vulnerabilities seriously. We appreciate your
The BiModal Design team takes security vulnerabilities seriously. We appreciate your
efforts to responsibly disclose your findings.

### How to Report a Security Vulnerability
Expand Down Expand Up @@ -56,7 +56,7 @@ When you report a vulnerability, you can expect:

### Security Best Practices for Users

When using AgentUX tools:
When using BiModal Design tools:

1. **Keep dependencies updated** - Run `npm audit` regularly
2. **Validate user input** - Even when using validation tools
Expand Down Expand Up @@ -113,4 +113,4 @@ upon request

---

Thank you for helping keep AgentUX and its users safe!
Thank you for helping keep BiModal Design and its users safe!
4 changes: 2 additions & 2 deletions __tests__/setup.test.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* Setup and sanity tests for AgentUX
* Setup and sanity tests for BiModal Design
* Ensures the test environment is configured correctly
*/

Expand All @@ -22,7 +22,7 @@ describe('Test Environment', () => {
});
});

describe('AgentUX Framework', () => {
describe('BiModal Design Framework', () => {
test('should have core requirements defined', () => {
const foundationalRequirements = [
'FR-1: Initial Payload Accessibility',
Expand Down
Loading
Loading