Home / hirokaji / jp-ui-contracts · GitHub

DESIGN.md@templates/docsA

DESIGN.md@templates/docs from hirokaji/jp-ui-contracts is a DESIGN.md file: the design rules coding agents follow in that repo.

Install it, pinned

mdr add hirokaji/jp-ui-contracts/templates/docs/DESIGN.md@git:20260411.d83a353

Pins git:20260411.d83a353 in mdr.lock. Pin the fingerprint instead.

Audit grade: A, 14 of 14 checks passed
Kind: DESIGN.md file
Repository: hirokaji/jp-ui-contracts
Path: templates/docs/DESIGN.md
Versions recorded: 1
Latest version: git:20260411.d83a353, committed Apr 11, 2026
Size: 1,387 bytes
Repository stars: 75
License: MIT

Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.

What the file says

# DESIGN.md — [Project Name]

> Profile: docs

---

## 0. Contract Metadata

- **Locale**: `ja-JP`
- **Profile**: `docs`
- **Review status**: `draft`

---

## 1. Documentation Intent

- Technical explanation is the primary use case
- Prose, code, table, callout, and navigation must be distinguishable
- Readers must be able to skim and dive

---

## 2. Typography Defaults

| Role | Size | Weight | Line Height | Letter Spacing | Notes |
|------|------|--------|-------------|----------------|------|
| H1 | 30px | 700 | 1.35 | 0 | page title |
| H2 | 24px | 700 | 1.4 | 0 | section title |
| H3 | 20px | 600 | 1.45 | 0 | subsection |
| Body | 16px | 400 | 1.7 | normal | explanation |
| Caption | 13px | 400 | 1.6 | normal | note/support |
| Code | 14px | 400 | 1.7 | 0 | code/text contrast |

### Rules
- Paragraph rhythm must support sustained reading
- Code blocks must not inherit paragraph spacing blindly
- Tables must not use article defaults
- Mixed Japanese and English technical terms must remain legible

---

## 3. Layout Defaults

- Reading width should support code and prose balance
- Long lines in code must have a clear handling policy
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint

mdr add hirokaji/jp-ui-contracts/templates/docs/DESIGN.md@sha256:036211bb2ce96d7a

The line at the top of this page pins the label git:20260411.d83a353, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.

Badge

[![mdr](https://markdownregistry.com/badge/art_2olm3b72bbph5myu.svg)](https://markdownregistry.com/a/art_2olm3b72bbph5myu)

6 badge image fetches in 30 days. What the badge shows.

Versions

The registry has recorded 1 version of this file, committed on Apr 11, 2026.

version	committed	commit	size	audit
git:20260411.d83a353 latest	2026-04-11	d83a353	1,387 B	A	view

Audit of the latest version

A 14 of 14 checks passed. Fixed automatic checks with no AI involved, so the same checks give the same answer every run.

pass: Size between 200 bytes and 200 KB (1387 bytes)
pass: No zero-width or bidi control characters
pass: No instruction hidden inside an HTML comment
pass: No link to an exfiltration or paste host
pass: No credential-shaped string
pass: No instruction to send local credentials anywhere
pass: No text hidden with inline styles
pass: No prompt-injection phrasing
pass: No curl or wget piped into a shell
pass: No recursive delete of root, home or parent
pass: No instruction to read or print local credentials
pass: No base64 blob over 200 characters
pass: No link to a raw IP address
pass: No script tag

Source

GitHub

hirokaji/jp-ui-contracts · 75 stars · license MIT · pushed 2026-11-03 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_2olm3b72bbph5myu
GET https://markdownregistry.com/api/v1/resolve?ref=hirokaji/jp-ui-contracts/templates/docs/DESIGN.md
GET https://markdownregistry.com/api/v1/blob/036211bb2ce96d7ad73dd0b5000ae0a174f02d31e9c08584ce703e80c2c86d57

Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.

Guides: what DESIGN.md is and how agents use it · which agent file does what.