docs: slim the README, split out known issues and roadmap #85

New Issue

Closed

opened 2026-08-27 02:02:18 +00:00 by jcoffey-dev · 0 comments

jcoffey-dev commented

2026-08-27 02:02:18 +00:00

Owner

Split out, verbatim

Known issues / pending QA → KNOWN-ISSUES.md
Roadmap / not yet → ROADMAP.md (its "see Quick start" pointer now aims at the install docs, since that section no longer exists)

Dropped from the README, with links in their place

Was	Now
Configuration env-var table	docs.ihasmail.org/configure
Quick start (Docker)	docs.ihasmail.org/install
Keyboard shortcut list	docs.ihasmail.org/shortcuts
~40 lines of feature detail	ihasmail.org/#features + a six-bullet summary

Kept, tightened, because it is only true of this tree: architecture, dev commands, the mock, version numbers, deploying. A nav table near the top points at both sites and the two new files.

330 → 168 lines. Version examples refreshed from 2.16.57 to the current 2.16.84. Every docs and site link in the new text was checked against the built docs-site/site/ output and sections/*.php.

Merged 2026-08-26 as coffey-labs/ihasmail@906d17a48b

_{Rebuilt from: git history, session transcript.}

The README had grown to 330 lines and was serving three audiences at once — installing, using, and working on ihasmail. docs.ihasmail.org covers the first two and ihasmail.org covers the feature tour, so the README now links there rather than restating them. **Split out, verbatim** - `Known issues / pending QA` → **KNOWN-ISSUES.md** - `Roadmap / not yet` → **ROADMAP.md** (its "see Quick start" pointer now aims at the install docs, since that section no longer exists) **Dropped from the README, with links in their place** | Was | Now | | --- | --- | | Configuration env-var table | [docs.ihasmail.org/configure](https://docs.ihasmail.org/configure/) | | Quick start (Docker) | [docs.ihasmail.org/install](https://docs.ihasmail.org/install/) | | Keyboard shortcut list | [docs.ihasmail.org/shortcuts](https://docs.ihasmail.org/shortcuts/) | | ~40 lines of feature detail | [ihasmail.org/#features](https://ihasmail.org/#features) + a six-bullet summary | **Kept**, tightened, because it is only true of this tree: architecture, dev commands, the mock, version numbers, deploying. A nav table near the top points at both sites and the two new files. 330 → 168 lines. Version examples refreshed from 2.16.57 to the current 2.16.84. Every docs and site link in the new text was checked against the built `docs-site/site/` output and `sections/*.php`. **Merged** 2026-08-26 as coffey-labs/ihasmail@906d17a48b8e <sub>Rebuilt from: git history, session transcript.</sub>

This repo is archived. You cannot comment on issues.

1 Participants

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: coffey-labs/ihasmail-github-archive#85