Skip to content

docs: add interface-copy and UX/DX/AX rules - #83

Open
JordanNanos wants to merge 2 commits into
masterfrom
docs/ux-dx-ax-guidance-20261025
Open

JordanNanos wants to merge 2 commits into
masterfrom
docs/ux-dx-ax-guidance-20261025

Conversation

@JordanNanos

Copy link
Copy Markdown
Contributor

Purpose

Record Jordan's interface-copy and decision rules in the repository's agent guidance.

What changed

  • AGENTS.md contains both requested rules verbatim under UX, DX and AX.
  • Existing repository instructions remain intact.
  • A new guidance file links to existing instructions where applicable.

Effect

  • Users: Future interface changes should remove redundant copy and improve unclear layouts.
  • Operators: This change does not alter deployment or approval requirements.
  • Developers: The rules require decisions that improve the experience without breaking existing behavior.
  • Data and compatibility: This change does not modify code, data, interfaces or dependencies.

Technical terms

  • AGENTS.md is the repository instruction file for coding agents.
  • UX means user experience.
  • DX means developer experience.
  • AX means agent experience.
  • A pull request (PR) proposes a change for repository review.

Validation

  • git diff --check passed.
  • Manual review confirmed that both rules match the user's text and existing instructions remain intact.
  • Runtime tests were not run because only Markdown guidance changed.

Merge plan

  • Merge order: None. This PR can merge independently.
  • Dependency: None.
  • Release step: None.

Design decisions for approval

  • Approval required: No additional design decision is required for the wording.
  • Decision: Jordan requested both rules verbatim.
  • Options: None.
  • Recommendation: Keep both rules in the root guidance file.
  • Approver: Existing repository merge requirements remain in effect.

Risk and recovery

  • Risk: Future edits could mistake necessary warnings or accessible labels for redundant copy.
  • Safeguard: Existing safety, accessibility, validation and compatibility requirements remain in effect.
  • Rollback: Revert this documentation commit.

Excluded work

  • This PR does not change any page or application behavior.
  • The requested page cleanup uses separate PRs for the five selected dashboards.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants