Skip to content

Commit 2ef9418

Browse files
committed
docs: add CLAUDE.md with site structure and conventions
1 parent d650f48 commit 2ef9418

1 file changed

Lines changed: 58 additions & 0 deletions

File tree

CLAUDE.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# huje-tools.web.landingpage.src
2+
3+
Public landing page for [huje.tools](https://huje.tools). Static HTML hosted on GitHub Pages.
4+
5+
## Structure
6+
7+
```
8+
docs/ ← GitHub Pages source (served from main branch)
9+
index.html ← Main landing page — 5 tool cards with code examples
10+
social-alignment.html ← /social-alignment docs page
11+
nostr-profile.html ← /nostr-profile docs page
12+
sense-memory.html ← /sense-memory docs page
13+
sense-music.html ← /sense-music docs page
14+
socialcard.html ← /socialcard docs page
15+
support.html ← /support — terms and contact
16+
og-image.png ← Main site OG image
17+
og-sense-memory.png ← Per-tool OG images (generated with socialcard)
18+
og-nostr-profile.png
19+
og-social-alignment.png
20+
og-sense-music.png
21+
og-socialcard.png
22+
CNAME ← Custom domain: huje.tools
23+
```
24+
25+
## How to Work With This Repo
26+
27+
- **No build step.** Edit HTML directly. Push to `main` and GitHub Pages deploys.
28+
- **No JavaScript** (except Plausible analytics). Pure HTML + inline CSS.
29+
- **Design system:** Dark theme. `--bg: #0f172a`, `--card: #1e293b`, `--orange: #f97316`, `--text: #f8fafc`. System font stack, monospace for code.
30+
- **Code highlighting:** `.kw` (purple), `.str` (green), `.fn` (blue), `.comment` (dim gray).
31+
- **Mobile responsive.** Media query at 600px.
32+
- **Reduced motion.** `prefers-reduced-motion` disables transitions.
33+
- **Plausible analytics** on every page — same snippet in every `<head>`.
34+
35+
## Tool Pages Pattern
36+
37+
Each tool gets a dedicated page following the same template:
38+
1. Breadcrumb (`huje.tools / toolname`)
39+
2. Hero with tagline, install bar, links (PyPI, ClawHub, Source, Docs)
40+
3. Quickstart code block
41+
4. How it works / capabilities
42+
5. API reference with tables
43+
6. Security section
44+
7. Configuration tables
45+
8. NIPs used (if applicable)
46+
9. Ecosystem section (links to NSE and sibling tools)
47+
10. Footer
48+
49+
OG images generated with `socialcard` package (eating our own dogfood).
50+
51+
## Conventions
52+
53+
- Inline CSS only (no external stylesheets)
54+
- Tool cards on index link to PyPI (primary), ClawHub, Source, and Docs (per-tool page)
55+
- Example code uses generic names: `Johnny5`, `johnny5@example.com`, `https://example.com`
56+
- Brand references only in footers and company attribution (humanjava.com)
57+
- `relay.nostrkeep.com` is the default relay in examples (our product)
58+
- Keep claims honest — only show what's live and working

0 commit comments

Comments
 (0)