Skip to content

Commit ccbac25

Browse files
committed
update docs
1 parent 59dda48 commit ccbac25

6 files changed

Lines changed: 347 additions & 350 deletions

File tree

.claude/settings.local.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@
1010
"Bash(hugo version:*)",
1111
"Bash(hugo mod graph:*)",
1212
"Bash(make docs-sync:*)",
13-
"WebFetch(domain:raw.githubusercontent.com)"
13+
"WebFetch(domain:raw.githubusercontent.com)",
14+
"Bash(./scripts/sync-readme-to-docs.sh:*)"
1415
]
1516
}
1617
}

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -131,12 +131,12 @@ yay -S neomd-bin
131131

132132
On first run, neomd:
133133
1. Creates `~/.config/neomd/config.toml` with placeholders — fill in your IMAP/SMTP credentials
134-
- Important: Make sure that the Capitalization and naming of folder in `config.toml` is accroding to webmail IMAP, e.g. [Gmails](docs/gmail.md) uses `sent = "[Gmail]/Sent Mail"` and not `sent` etc.
134+
- Important: Make sure that the Capitalization and naming of folder in `config.toml` is accroding to webmail IMAP, e.g. [Gmails](docs/content/docs/configurations/gmail.md) uses `sent = "[Gmail]/Sent Mail"` and not `sent` etc.
135135
2. Creates `~/.config/neomd/lists/` for screener allowlists (or uses your custom paths from config)
136136
3. Creates any missing IMAP folders (ToScreen, Feed, PaperTrail, etc.) automatically
137137

138138

139-
Neomd also runs on Android (more for fun) — see [docs/android.md](docs/android.md).
139+
Neomd also runs on Android (more for fun) — see [docs/content/docs/configurations/android.md](docs/content/docs/android.md).
140140

141141
## Configuration
142142

@@ -166,11 +166,11 @@ spam = "~/.config/neomd/lists/spam.txt"
166166

167167
Use an app-specific password (Gmail, Fastmail, Hostpoint, etc.) rather than your main account password. The `password` and `user` fields support environment variable expansion (`$VAR` or `${VAR}`) so you can avoid storing secrets in the config file.
168168

169-
For the full configuration reference including multiple accounts, OAuth2 authentication, `[[senders]]` aliases, folder customization, signatures, and UI options, see [docs/configuration.md](docs/configuration.md).
169+
For the full configuration reference including multiple accounts, OAuth2 authentication, `[[senders]]` aliases, folder customization, signatures, and UI options, see [docs/content/docs/configuration.md](docs/content/docs/configuration.md).
170170

171171
**Provider-specific guides:**
172-
- Gmail: [docs/gmail.md](docs/gmail.md) — folder name mapping and OAuth2 setup
173-
- Proton Mail Bridge: [docs/proton-bridge.md](docs/proton-bridge.md) — non-standard port configuration
172+
- Gmail: [docs/content/docs/configurations/gmail.md](docs/content/docs/configurations/gmail.md) — folder name mapping and OAuth2 setup
173+
- Proton Mail Bridge: [docs/content/docs/configurations/proton-bridge.md](docs/content/docs/configurations/proton-bridge.md) — non-standard port configuration
174174

175175
### Onboarding
176176

@@ -201,21 +201,21 @@ You choose who can land in your Inbox. Bye-bye spam. This is the beauty of [HEY-
201201
202202
### Screener Workflow
203203

204-
Find full Screener Workflow at [docs/screener.md](docs/screener.md), classification tables, and bulk re-classification instructions.
204+
Find full Screener Workflow at [docs/content/docs/screener.md](docs/content/docs/screener.md), classification tables, and bulk re-classification instructions.
205205
### Keybindings
206206

207207
Press `?` inside neomd to open the interactive help overlay. Start typing to filter shortcuts.
208208

209-
See the [full keybindings reference](docs/keybindings.md) (auto-generated from [`internal/ui/keys.go`](internal/ui/keys.go) via `make docs`).
209+
See the [full keybindings reference](docs/content/docs/keybindings.md) (auto-generated from [`internal/ui/keys.go`](internal/ui/keys.go) via `make docs`).
210210

211211
### How Sending Works
212212

213213
Compose in Markdown, send as `multipart/alternative` (plain text + HTML). Attachments, CC/BCC, multiple From addresses, drafts, and pre-send review are all supported.
214214

215215
Discarding unsent mail now asks for confirmation in compose/pre-send, and `:recover` reopens the latest backup if you want to resume after an abort.
216216

217-
- See [docs/sending.md](docs/sending.md) for details on MIME structure, attachments, pre-send review, and drafts.
218-
- See [docs/reading.md](docs/reading.md) for the reader: images, inline links, attachments, and navigation.
217+
- See [docs/content/docs/sending.md](docs/content/docs/sending.md) for details on MIME structure, attachments, pre-send review, and drafts.
218+
- See [docs/content/docs/reading.md](docs/content/docs/reading.md) for the reader: images, inline links, attachments, and navigation.
219219

220220
### Dev: Makefile Commands
221221

@@ -278,7 +278,7 @@ Interestingly, Gmail benchmarks fast on a **fresh single connection** (`scripts/
278278

279279

280280
> [!NOTE]
281-
> **Gmail is not recommended.** If you're on Gmail, consider a dedicated email provider (Hostpoint, Fastmail, HEY, Migadu, etc.) for the best neomd experience. Or use Gmail just for fun :). See [docs/gmail.md](docs/gmail.md) for Gmail-specific folder configuration.
281+
> **Gmail is not recommended.** If you're on Gmail, consider a dedicated email provider (Hostpoint, Fastmail, HEY, Migadu, etc.) for the best neomd experience. Or use Gmail just for fun :). See [docs/content/docs/configurations/gmail.md](docs/content/docs/configurations/gmail.md) for Gmail-specific folder configuration.
282282
283283
**Test your own provider:**
284284
```bash
@@ -311,7 +311,7 @@ This TUI is mostly [vibe-coded](https://www.ssp.sh/brain/vibe-coding) in the sen
311311

312312
I used my experience with Neomutt, TUIs, and the GTD workflow for handling emails with HEY Screener, and added some (hopefully) _taste_ using my favorite tools and aesthetics. Find the full history at [Twitter](https://xcancel.com/sspaeti/status/2036539855182627169#m) - inspired by seeing [Email.md](https://www.emailmd.dev/) on HackerNews.
313313

314-
If you [rather read the prompt](https://www.ssp.sh/brain/id-rather-read-the-prompt), check out my [initial prompt](docs/initial-prompt/prompt.md) and its generated [plan](docs/initial-prompt/prompt-plan.md) - which I have iterated and added features by the 100s since then.
314+
If you [rather read the prompt](https://www.ssp.sh/brain/id-rather-read-the-prompt), check out my [initial prompt](https://github.com/ssp-data/neomd/blob/main/docs/initial-prompt/prompt.md) and its generated [plan](https://github.com/ssp-data/neomd/blob/main/docs/initial-prompt/prompt-plan.md) - which I have iterated and added features by the 100s since then.
315315
## Roadmap
316316

317317
See at my second brain at [Roadmap](https://www.ssp.sh/brain/neomd#roadmap).

docs/content/_index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ toc: false
1717
</div>
1818

1919
<div class="hx-mb-6">
20-
{{< hextra/hero-button text="Overview and Philosophy" link="docs/overview" >}}
20+
{{< hextra/hero-button text="Overview and Philosophy" link="docs" >}}
2121
</div>
2222

2323
<div class="hx-mt-6"></div>
@@ -80,7 +80,7 @@ YouTube rundown of most features:
8080
</div>
8181

8282
{{< cards cols="3" >}}
83-
{{< card link="docs/overview" title="Overview & Philosophy" subtitle="Full feature list, installation (binary, AUR, source), philosophy, benchmarks, and inspiration" >}}
83+
{{< card link="docs" title="Overview & Philosophy" subtitle="Full feature list, installation (binary, AUR, source), philosophy, benchmarks, and inspiration" >}}
8484
{{< card link="docs/configuration" title="Configuration Reference" subtitle="Full config with multiple accounts, OAuth2, signatures, and UI options" >}}
8585
{{< card link="docs/keybindings" title="Keybindings" subtitle="Complete keyboard shortcuts reference (auto-generated from source)" >}}
8686
{{< card link="docs/screener" title="Screener Workflow" subtitle="How to classify emails, bulk operations, and screener lists" >}}
@@ -91,7 +91,7 @@ YouTube rundown of most features:
9191
<br>
9292

9393
<div class="hx-mb-6">
94-
{{< hextra/hero-button text="Getting Started: Install" link="docs/overview#install" >}}
94+
{{< hextra/hero-button text="Getting Started: Install" link="docs#install" >}}
9595
</div>
9696

9797

0 commit comments

Comments
 (0)