Skip to content

Commit f4a7a6a

Browse files
authored
docs: site copy
1 parent 7e0ca03 commit f4a7a6a

7 files changed

Lines changed: 120 additions & 145 deletions

File tree

README.md

Lines changed: 12 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -67,23 +67,16 @@ opencode
6767
Example output:
6868

6969
```
70-
===============================================
71-
BITCOINUI REVIEW: SendFeeView.swift
72-
===============================================
73-
74-
MEDIUM (1 issue)
75-
------------------
76-
[UX] Line 88: Fee picker lacks a high-fee warning
77-
Fix: Add a warning when fee >= 50% of amount.
78-
Reference: Bitcoin Design Guide — Send fees https://bitcoin.design/guide/daily-spending-wallet/sending/send-fees/
79-
80-
LOW (1 issue)
81-
------------------
82-
[A11Y] Line 42: Icon-only close button has no label
83-
Fix: Add accessibilityLabel("Close")
84-
Reference: iOS HIG — Accessibility https://developer.apple.com/design/human-interface-guidelines/accessibility
85-
86-
===============================================
87-
SUMMARY: 0 high, 1 medium, 1 low
88-
===============================================
70+
BITCOINUI
71+
72+
SendFeeView.swift
73+
Findings: 0 high, 2 medium, 0 low
74+
75+
Medium
76+
1) [UX L88] Fee picker lacks a high-fee warning
77+
Fix: Add a warning when fee >= 50% of amount.
78+
Ref: Bitcoin Design Guide — Send fees https://bitcoin.design/guide/daily-spending-wallet/sending/send-fees/
79+
2) [A11Y L42] Icon-only close button has no label
80+
Fix: Add accessibilityLabel("Close")
81+
Ref: iOS HIG — Accessibility https://developer.apple.com/design/human-interface-guidelines/accessibility
8982
```

commands/bitcoinui.md

Lines changed: 22 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -30,42 +30,36 @@ If `$ARGUMENTS` is empty, ask: "Using the bitcoinui command for an iOS review. W
3030

3131
## Output Format
3232

33-
Start directly with the `BITCOINUI REVIEW` block; do not add any preamble text before it.
34-
Omit any severity section with 0 issues (including LOW).
33+
Start directly with the `BITCOINUI` block; do not add any preamble text before it.
34+
Omit any severity section with 0 findings (including Low).
3535

3636
```
37-
===============================================
38-
BITCOINUI REVIEW: [filename]
39-
===============================================
40-
41-
HIGH (X issues)
42-
------------------
43-
[UX] Line 42: Missing warning for fee > amount
44-
Fix: Add a warning state when fee >= 50% of amount.
45-
Reference: Bitcoin Design Guide — Send fees https://bitcoin.design/guide/daily-spending-wallet/sending/send-fees/
46-
47-
MEDIUM (X issues)
48-
------------------
49-
[A11Y] Line 18: Icon-only button has no label
50-
Fix: Add accessibilityLabel("Close")
51-
Reference: iOS HIG — Accessibility https://developer.apple.com/design/human-interface-guidelines/accessibility
52-
53-
LOW (X issues)
54-
------------------
55-
...
56-
57-
===============================================
58-
SUMMARY: X high, X medium, X low
59-
===============================================
37+
BITCOINUI
38+
39+
[file-or-folder]
40+
Findings: X high, X medium, X low
41+
42+
High
43+
1) [UX L42] Missing warning for fee > amount
44+
Fix: Add a warning state when fee >= 50% of amount.
45+
Ref: Bitcoin Design Guide — Send fees https://bitcoin.design/guide/daily-spending-wallet/sending/send-fees/
46+
47+
Medium
48+
1) [A11Y L18] Icon-only button has no label
49+
Fix: Add accessibilityLabel("Close")
50+
Ref: iOS HIG — Accessibility https://developer.apple.com/design/human-interface-guidelines/accessibility
51+
52+
Low
53+
1) ...
6054
```
6155

6256
## Guidance
6357

6458
1. Read the file(s) first before making assessments.
6559
2. Be specific with line numbers and code snippets.
6660
3. Provide fixes, not just problems.
67-
4. Include a direct URL in each Reference line.
68-
5. For Bitcoin-specific issues, include at least one Bitcoin Design Guide or BIP URL in the Reference line.
61+
4. Include a direct URL in each Ref line.
62+
5. For Bitcoin-specific issues, include at least one Bitcoin Design Guide or BIP URL in the Ref line.
6963
6. Suggest BitcoinUI components when they fit the pattern.
70-
7. LOW is for optional polish/consistency notes; skip it if there are no meaningful suggestions.
64+
7. Low is for optional polish/consistency notes; skip it if there are no meaningful suggestions.
7165
8. Do not modify code unless asked; offer to fix if appropriate.

site/bitcoinui.md

Lines changed: 22 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -30,42 +30,36 @@ If `$ARGUMENTS` is empty, ask: "Using the bitcoinui command for an iOS review. W
3030

3131
## Output Format
3232

33-
Start directly with the `BITCOINUI REVIEW` block; do not add any preamble text before it.
34-
Omit any severity section with 0 issues (including LOW).
33+
Start directly with the `BITCOINUI` block; do not add any preamble text before it.
34+
Omit any severity section with 0 findings (including Low).
3535

3636
```
37-
===============================================
38-
BITCOINUI REVIEW: [filename]
39-
===============================================
40-
41-
HIGH (X issues)
42-
------------------
43-
[UX] Line 42: Missing warning for fee > amount
44-
Fix: Add a warning state when fee >= 50% of amount.
45-
Reference: Bitcoin Design Guide — Send fees https://bitcoin.design/guide/daily-spending-wallet/sending/send-fees/
46-
47-
MEDIUM (X issues)
48-
------------------
49-
[A11Y] Line 18: Icon-only button has no label
50-
Fix: Add accessibilityLabel("Close")
51-
Reference: iOS HIG — Accessibility https://developer.apple.com/design/human-interface-guidelines/accessibility
52-
53-
LOW (X issues)
54-
------------------
55-
...
56-
57-
===============================================
58-
SUMMARY: X high, X medium, X low
59-
===============================================
37+
BITCOINUI
38+
39+
[file-or-folder]
40+
Findings: X high, X medium, X low
41+
42+
High
43+
1) [UX L42] Missing warning for fee > amount
44+
Fix: Add a warning state when fee >= 50% of amount.
45+
Ref: Bitcoin Design Guide — Send fees https://bitcoin.design/guide/daily-spending-wallet/sending/send-fees/
46+
47+
Medium
48+
1) [A11Y L18] Icon-only button has no label
49+
Fix: Add accessibilityLabel("Close")
50+
Ref: iOS HIG — Accessibility https://developer.apple.com/design/human-interface-guidelines/accessibility
51+
52+
Low
53+
1) ...
6054
```
6155

6256
## Guidance
6357

6458
1. Read the file(s) first before making assessments.
6559
2. Be specific with line numbers and code snippets.
6660
3. Provide fixes, not just problems.
67-
4. Include a direct URL in each Reference line.
68-
5. For Bitcoin-specific issues, include at least one Bitcoin Design Guide or BIP URL in the Reference line.
61+
4. Include a direct URL in each Ref line.
62+
5. For Bitcoin-specific issues, include at least one Bitcoin Design Guide or BIP URL in the Ref line.
6963
6. Suggest BitcoinUI components when they fit the pattern.
70-
7. LOW is for optional polish/consistency notes; skip it if there are no meaningful suggestions.
64+
7. Low is for optional polish/consistency notes; skip it if there are no meaningful suggestions.
7165
8. Do not modify code unless asked; offer to fix if appropriate.

site/index.html

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,14 @@
2020
href="https://fonts.googleapis.com/css2?family=DM+Mono:wght@300;400;500&display=swap"
2121
rel="stylesheet"
2222
>
23-
<link rel="stylesheet" href="style.css?v=6">
23+
<link rel="stylesheet" href="style.css?v=7">
2424
</head>
2525
<body>
2626
<main class="page">
2727
<div class="panel">
2828
<div class="panel-body">
2929
<h1>Bitcoin UI</h1>
30-
<p class="note">AI DESIGN REVIEW &amp; LIBRARY FOR BITCOIN IOS APPS</p>
30+
<p class="note">DESIGN REVIEW &amp; LIBRARY FOR BITCOIN IOS APPS</p>
3131
<hr class="divider">
3232

3333
<div class="section-group">
@@ -61,15 +61,21 @@ <h2><a href="https://opencode.ai/docs/commands/">OpenCode</a></h2>
6161
</section>
6262

6363
<section class="block" id="flow">
64-
<p class="note"><em>INSTALL -&gt; RUN BITCOINUI -&gt; GET A DESIGN REVIEW</em></p>
65-
<pre class="output-block"><code>BITCOINUI REVIEW: SendFeeView.swift
66-
===================================
67-
MEDIUM (1 issue)
68-
---------------
69-
[UX] Line 88: Fee picker lacks a high-fee warning
70-
Fix: Add a warning when fee &gt;= 50% of amount.
71-
Reference: Bitcoin Design Guide - Send fees https://bitcoin.design/guide/daily-spending-wallet/sending/send-fees/
72-
SUMMARY: 0 high, 1 medium, 0 low</code></pre>
64+
<p class="note"><em>install -&gt; run bitcoinui -&gt; get a design review</em></p>
65+
<pre class="output-block"><code>BITCOINUI
66+
67+
SendFeeView.swift
68+
Findings: 0 high, 2 medium, 0 low
69+
70+
Medium
71+
72+
1) [UX L88] Fee picker lacks a high-fee warning
73+
Fix: Add a warning when fee &gt;= 50% of amount.
74+
Ref: Bitcoin Design Guide - Send fees https://bitcoin.design/guide/daily-spending-wallet/sending/send-fees/
75+
2) [A11Y L142] Icon-only button has no label
76+
Fix: Add an accessibilityLabel("Close") and include visible text.
77+
Ref: iOS HIG - Accessibility https://developer.apple.com/design/human-interface-guidelines/accessibility</code></pre>
78+
7379
</section>
7480
</div>
7581

site/skills/bitcoinui/SKILL.md

Lines changed: 23 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -19,42 +19,36 @@ Review iOS SwiftUI code and screens for Bitcoin-specific UX correctness, iOS HIG
1919

2020
1. Read the target file(s) before commenting.
2121
2. Apply the rubric in `references/bitcoinui-rubric.md`.
22-
3. Report issues by severity with line numbers, a short snippet, and a concrete fix. Include a direct URL in each Reference line.
23-
4. For Bitcoin-specific issues, include at least one Bitcoin Design Guide or BIP URL in the Reference line.
22+
3. Report issues by severity with line numbers, a short snippet, and a concrete fix. Include a direct URL in each Ref line.
23+
4. For Bitcoin-specific issues, include at least one Bitcoin Design Guide or BIP URL in the Ref line.
2424
5. Suggest BitcoinUI components when they would reduce errors or improve consistency.
25-
6. Omit any severity section with 0 issues (including LOW).
26-
7. LOW is for optional polish/consistency notes; skip it if there are no meaningful suggestions.
25+
6. Omit any severity section with 0 findings (including Low).
26+
7. Low is for optional polish/consistency notes; skip it if there are no meaningful suggestions.
2727
8. Do not modify code unless the user asks; offer to fix if appropriate.
2828

2929
## Output Format
3030

31-
Start directly with the `BITCOINUI REVIEW` block; do not add any preamble text before it.
32-
Omit any severity section with 0 issues (including LOW).
31+
Start directly with the `BITCOINUI` block; do not add any preamble text before it.
32+
Omit any severity section with 0 findings (including Low).
3333

3434
```
35-
===============================================
36-
BITCOINUI REVIEW: [filename]
37-
===============================================
38-
39-
HIGH (X issues)
40-
------------------
41-
[UX] Line 42: Missing warning for fee > amount
42-
Fix: Add a warning state when fee >= 50% of amount.
43-
Reference: Bitcoin Design Guide — Send fees https://bitcoin.design/guide/daily-spending-wallet/sending/send-fees/
44-
45-
MEDIUM (X issues)
46-
------------------
47-
[A11Y] Line 18: Icon-only button has no label
48-
Fix: Add accessibilityLabel("Close")
49-
Reference: iOS HIG — Accessibility https://developer.apple.com/design/human-interface-guidelines/accessibility
50-
51-
LOW (X issues)
52-
------------------
53-
...
54-
55-
===============================================
56-
SUMMARY: X high, X medium, X low
57-
===============================================
35+
BITCOINUI
36+
37+
[file-or-folder]
38+
Findings: X high, X medium, X low
39+
40+
High
41+
1) [UX L42] Missing warning for fee > amount
42+
Fix: Add a warning state when fee >= 50% of amount.
43+
Ref: Bitcoin Design Guide — Send fees https://bitcoin.design/guide/daily-spending-wallet/sending/send-fees/
44+
45+
Medium
46+
1) [A11Y L18] Icon-only button has no label
47+
Fix: Add accessibilityLabel("Close")
48+
Ref: iOS HIG — Accessibility https://developer.apple.com/design/human-interface-guidelines/accessibility
49+
50+
Low
51+
1) ...
5852
```
5953

6054
## References

site/style.css

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ h2 a {
109109
}
110110

111111
h2 a:hover {
112-
color: var(--orange);
112+
color: var(--green);
113113
}
114114

115115
.section-title {

skills/bitcoinui/SKILL.md

Lines changed: 23 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -19,42 +19,36 @@ Review iOS SwiftUI code and screens for Bitcoin-specific UX correctness, iOS HIG
1919

2020
1. Read the target file(s) before commenting.
2121
2. Apply the rubric in `references/bitcoinui-rubric.md`.
22-
3. Report issues by severity with line numbers, a short snippet, and a concrete fix. Include a direct URL in each Reference line.
23-
4. For Bitcoin-specific issues, include at least one Bitcoin Design Guide or BIP URL in the Reference line.
22+
3. Report issues by severity with line numbers, a short snippet, and a concrete fix. Include a direct URL in each Ref line.
23+
4. For Bitcoin-specific issues, include at least one Bitcoin Design Guide or BIP URL in the Ref line.
2424
5. Suggest BitcoinUI components when they would reduce errors or improve consistency.
25-
6. Omit any severity section with 0 issues (including LOW).
26-
7. LOW is for optional polish/consistency notes; skip it if there are no meaningful suggestions.
25+
6. Omit any severity section with 0 findings (including Low).
26+
7. Low is for optional polish/consistency notes; skip it if there are no meaningful suggestions.
2727
8. Do not modify code unless the user asks; offer to fix if appropriate.
2828

2929
## Output Format
3030

31-
Start directly with the `BITCOINUI REVIEW` block; do not add any preamble text before it.
32-
Omit any severity section with 0 issues (including LOW).
31+
Start directly with the `BITCOINUI` block; do not add any preamble text before it.
32+
Omit any severity section with 0 findings (including Low).
3333

3434
```
35-
===============================================
36-
BITCOINUI REVIEW: [filename]
37-
===============================================
38-
39-
HIGH (X issues)
40-
------------------
41-
[UX] Line 42: Missing warning for fee > amount
42-
Fix: Add a warning state when fee >= 50% of amount.
43-
Reference: Bitcoin Design Guide — Send fees https://bitcoin.design/guide/daily-spending-wallet/sending/send-fees/
44-
45-
MEDIUM (X issues)
46-
------------------
47-
[A11Y] Line 18: Icon-only button has no label
48-
Fix: Add accessibilityLabel("Close")
49-
Reference: iOS HIG — Accessibility https://developer.apple.com/design/human-interface-guidelines/accessibility
50-
51-
LOW (X issues)
52-
------------------
53-
...
54-
55-
===============================================
56-
SUMMARY: X high, X medium, X low
57-
===============================================
35+
BITCOINUI
36+
37+
[file-or-folder]
38+
Findings: X high, X medium, X low
39+
40+
High
41+
1) [UX L42] Missing warning for fee > amount
42+
Fix: Add a warning state when fee >= 50% of amount.
43+
Ref: Bitcoin Design Guide — Send fees https://bitcoin.design/guide/daily-spending-wallet/sending/send-fees/
44+
45+
Medium
46+
1) [A11Y L18] Icon-only button has no label
47+
Fix: Add accessibilityLabel("Close")
48+
Ref: iOS HIG — Accessibility https://developer.apple.com/design/human-interface-guidelines/accessibility
49+
50+
Low
51+
1) ...
5852
```
5953

6054
## References

0 commit comments

Comments
 (0)