Skip to content

Commit 911fdd7

Browse files
web-flowclaude
andcommitted
Optimize repo and site surfaces for SEO/GEO exposure
- English README as default (zh moved to README_zh.md), mermaid architecture diagram, crawler-visible demo caption, disambiguation line, stars badge - Canonical Apache-2.0 LICENSE text so GitHub license detection works - CONTRIBUTING, CODE_OF_CONDUCT, bug-report issue form - Site: disambiguation + runtime facts (LiteRT, not MLX), FAQ disambiguation Q&A restored, privacy data-flow section with Ollama-cloud qualification, definitional sections (framework category, LiveLand/LIVE), Mac remote requirements & troubleshooting, on-device requirements + memory reality, new /benchmarks/ page with sourced on-device footprints - zh/ja: translation fixes, katakana keywords, data-flow parity rows - Infra: social-card.png (1280x640) as og:image sitewide, sitemap +benchmarks, llms.txt to llmstxt.org format, IndexNow ping on deploy - PROMOTION_KIT aligned to canonical positioning sentence Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
1 parent 5a34626 commit 911fdd7

27 files changed

Lines changed: 1705 additions & 989 deletions

File tree

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
name: Bug report
2+
description: Report a problem with PhoneClaw on iPhone
3+
title: "[Bug] "
4+
labels: ["bug"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to report a bug. Device details matter a lot for on-device inference issues.
10+
- type: input
11+
id: device-model
12+
attributes:
13+
label: Device model
14+
description: The iPhone model you were using.
15+
placeholder: e.g. iPhone 15 Pro
16+
validations:
17+
required: true
18+
- type: input
19+
id: ios-version
20+
attributes:
21+
label: iOS version
22+
placeholder: e.g. iOS 18.5
23+
validations:
24+
required: true
25+
- type: input
26+
id: build-number
27+
attributes:
28+
label: TestFlight build number
29+
description: Shown in the TestFlight app next to the version. Write "source build" if you built from Xcode.
30+
placeholder: e.g. 46
31+
validations:
32+
required: true
33+
- type: dropdown
34+
id: model-in-use
35+
attributes:
36+
label: Model in use
37+
description: Which model was active when the problem happened.
38+
options:
39+
- Gemma 4 E2B (on-device)
40+
- Gemma 4 E4B (on-device)
41+
- MiniCPM-V 4.6 (on-device, multimodal)
42+
- Remote model via Mac Gateway
43+
- Not sure / not model-related
44+
validations:
45+
required: true
46+
- type: dropdown
47+
id: live-involved
48+
attributes:
49+
label: Was LIVE mode or LiveLand involved?
50+
options:
51+
- "No"
52+
- LIVE mode
53+
- LiveLand
54+
- Both
55+
validations:
56+
required: true
57+
- type: textarea
58+
id: steps
59+
attributes:
60+
label: Steps to reproduce
61+
description: What you did, what you expected, and what happened instead. Include the prompt or Skill involved if relevant.
62+
placeholder: |
63+
1. ...
64+
2. ...
65+
3. ...
66+
validations:
67+
required: true
68+
- type: textarea
69+
id: additional
70+
attributes:
71+
label: Additional context
72+
description: Crash logs, screenshots, memory warnings, or anything else that might help.
73+
validations:
74+
required: false

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: true

.github/workflows/pages.yml

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,3 +33,26 @@ jobs:
3333
path: site
3434
- id: deployment
3535
uses: actions/deploy-pages@v4
36+
- name: Notify IndexNow
37+
continue-on-error: true
38+
run: |
39+
curl -sS -X POST "https://api.indexnow.org/indexnow" \
40+
-H "Content-Type: application/json; charset=utf-8" \
41+
-d '{
42+
"host": "kellyvv.github.io",
43+
"key": "0bf623a9a5805fafd04bad9f20177812",
44+
"keyLocation": "https://kellyvv.github.io/PhoneClaw/0bf623a9a5805fafd04bad9f20177812.txt",
45+
"urlList": [
46+
"https://kellyvv.github.io/PhoneClaw/",
47+
"https://kellyvv.github.io/PhoneClaw/zh/",
48+
"https://kellyvv.github.io/PhoneClaw/ja/",
49+
"https://kellyvv.github.io/PhoneClaw/privacy/",
50+
"https://kellyvv.github.io/PhoneClaw/mac-remote/",
51+
"https://kellyvv.github.io/PhoneClaw/mobile-agent-framework/",
52+
"https://kellyvv.github.io/PhoneClaw/on-device-gemma/",
53+
"https://kellyvv.github.io/PhoneClaw/skills/",
54+
"https://kellyvv.github.io/PhoneClaw/liveland/",
55+
"https://kellyvv.github.io/PhoneClaw/faq/",
56+
"https://kellyvv.github.io/PhoneClaw/benchmarks/"
57+
]
58+
}'

CODE_OF_CONDUCT.md

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
2+
# Contributor Covenant Code of Conduct
3+
4+
## Our Pledge
5+
6+
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
7+
8+
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
9+
10+
## Our Standards
11+
12+
Examples of behavior that contributes to a positive environment for our community include:
13+
14+
* Demonstrating empathy and kindness toward other people
15+
* Being respectful of differing opinions, viewpoints, and experiences
16+
* Giving and gracefully accepting constructive feedback
17+
* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
18+
* Focusing on what is best not just for us as individuals, but for the overall community
19+
20+
Examples of unacceptable behavior include:
21+
22+
* The use of sexualized language or imagery, and sexual attention or advances of any kind
23+
* Trolling, insulting or derogatory comments, and personal or political attacks
24+
* Public or private harassment
25+
* Publishing others' private information, such as a physical or email address, without their explicit permission
26+
* Other conduct which could reasonably be considered inappropriate in a professional setting
27+
28+
## Enforcement Responsibilities
29+
30+
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
31+
32+
Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
33+
34+
## Scope
35+
36+
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
37+
38+
## Enforcement
39+
40+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at GitHub issues: https://github.com/kellyvv/PhoneClaw/issues. All complaints will be reviewed and investigated promptly and fairly.
41+
42+
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
43+
44+
## Enforcement Guidelines
45+
46+
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
47+
48+
### 1. Correction
49+
50+
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
51+
52+
**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
53+
54+
### 2. Warning
55+
56+
**Community Impact**: A violation through a single incident or series of actions.
57+
58+
**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
59+
60+
### 3. Temporary Ban
61+
62+
**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
63+
64+
**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
65+
66+
### 4. Permanent Ban
67+
68+
**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
69+
70+
**Consequence**: A permanent ban from any sort of public interaction within the community.
71+
72+
## Attribution
73+
74+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
75+
76+
Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder][Mozilla CoC].
77+
78+
For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at [https://www.contributor-covenant.org/translations][translations].
79+
80+
[homepage]: https://www.contributor-covenant.org
81+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
82+
[Mozilla CoC]: https://github.com/mozilla/diversity
83+
[FAQ]: https://www.contributor-covenant.org/faq
84+
[translations]: https://www.contributor-covenant.org/translations
85+

CONTRIBUTING.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Contributing to PhoneClaw
2+
3+
Thanks for your interest in the project. Contributions of all kinds are welcome — bug reports, documentation fixes, and code.
4+
5+
## Building from source
6+
7+
Requirements (from the [README](README.md)):
8+
9+
- macOS + Xcode 16 or later
10+
- iOS 17.0 or later
11+
- CocoaPods
12+
- A real device with a developer account (Apple ID)
13+
14+
```bash
15+
git clone https://github.com/kellyvv/PhoneClaw.git
16+
cd PhoneClaw
17+
pod install
18+
```
19+
20+
Open `PhoneClaw.xcworkspace` in Xcode and build for a **physical iPhone** (`-destination 'generic/platform=iOS'` when using `xcodebuild`). The iOS Simulator is not a supported build destination: the bundled `Frameworks/piper_plus.xcframework` (as well as `sherpa-onnx.xcframework` and `onnxruntime.xcframework`) ships only an `ios-arm64` device slice, so simulator builds fail to link.
21+
22+
## Filing issues
23+
24+
Please open issues at <https://github.com/kellyvv/PhoneClaw/issues>. For bugs, include:
25+
26+
- Device model (e.g. iPhone 15 Pro)
27+
- iOS version
28+
- TestFlight build number (shown in TestFlight, or in the app's settings)
29+
- Which model was in use (Gemma 4 E2B / E4B, MiniCPM-V 4.6, or a remote Mac Gateway model)
30+
- Steps to reproduce, and whether LIVE mode or LiveLand was involved
31+
32+
There is a bug report form in the issue tracker that walks through these fields.
33+
34+
## Pull requests
35+
36+
PRs are welcome. For anything beyond a small fix, please open an issue first to discuss the change — the runtime has tight memory and threading constraints on device, and early discussion avoids wasted work. Keep changes focused and describe how you tested them (device model and build configuration).
37+
38+
## Code of conduct
39+
40+
This project follows the [Contributor Covenant](CODE_OF_CONDUCT.md).

Docs/ON_DEVICE_GEMMA.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,6 @@ This keeps local agent behavior more predictable and makes privacy boundaries vi
6060
## Useful links
6161

6262
- [README](../README.md)
63-
- [English README](../README_EN.md)
63+
- [中文 README](../README_zh.md)
6464
- [PhoneClaw Skill System](SKILL_SYSTEM.md)
6565
- [iOS Memory and Context Limits](IOS_MEMORY_LIMITS.md)

Docs/PROMOTION_KIT.md

Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,11 @@ Short copy, post templates, and positioning notes for sharing PhoneClaw.
44

55
## One-line positioning
66

7-
English:
7+
Canonical (use this verbatim in launches, listings, and directory submissions — matches Docs/SEO_GEO_STRATEGY.md):
8+
9+
> PhoneClaw is a mobile-native local AI Agent framework for phones and edge devices. Its iOS runtime runs on-device models and native iOS Skills by default, and supports optional Mac Gateway remote inference for heavier local models.
10+
11+
English (short variant):
812

913
> PhoneClaw turns phones into local AI agent runtimes with on-device models, native mobile Skills, LiveLand, and optional Mac Gateway inference.
1014
@@ -79,13 +83,16 @@ TestFlight: https://testflight.apple.com/join/YuUSwq78
7983
## Hacker News / Reddit style post
8084

8185
```text
82-
Show HN: PhoneClaw - a local AI agent runtime for phones
86+
Show HN: PhoneClaw - a mobile-native local AI Agent framework
87+
88+
PhoneClaw is a mobile-native local AI Agent framework for phones and edge devices. Its iOS runtime runs on-device models and native iOS Skills by default, and supports optional Mac Gateway remote inference for heavier local models.
8389
8490
PhoneClaw runs inference and Skill calls on device. It is designed for practical phone workflows: calendar queries, reminders, contacts, HealthKit summaries, clipboard, image understanding, voice, LiveLand, and explicit Web Search.
8591
8692
The Skill system is file-driven: each capability is defined by SKILL.md and backed by permission-scoped native mobile tools.
8793
8894
GitHub: https://github.com/kellyvv/PhoneClaw
95+
Site: https://kellyvv.github.io/PhoneClaw/
8996
TestFlight: https://testflight.apple.com/join/YuUSwq78
9097
```
9198

@@ -118,21 +125,30 @@ Point to show: multimodal reasoning on the phone.
118125
## Suggested GitHub topics
119126

120127
```text
128+
agent-framework
129+
ai-agent
130+
edge-ai
121131
gemma
122-
on-device-ai
132+
healthkit
133+
ios
134+
litert
123135
local-agent
136+
local-ai
124137
mobile-agent
125-
ai-agent
126-
phone-harness
127-
phone-loop
128-
litert
138+
mobile-ai
139+
offline-ai
140+
ollama
141+
on-device-ai
129142
swift
130-
ios
143+
swiftui
131144
```
132145

133146
## Useful links
134147

135148
- GitHub: https://github.com/kellyvv/PhoneClaw
149+
- Site: https://kellyvv.github.io/PhoneClaw/
150+
- Chinese landing: https://kellyvv.github.io/PhoneClaw/zh/
151+
- Benchmarks: https://kellyvv.github.io/PhoneClaw/benchmarks/
136152
- TestFlight: https://testflight.apple.com/join/YuUSwq78
137153
- On-device Gemma note: ON_DEVICE_GEMMA.md
138154
- Skill system note: SKILL_SYSTEM.md

0 commit comments

Comments
 (0)