Shorter README: an introduction and links #368

New Issue

Closed

opened 2026-09-15 17:52:07 +00:00 by jcoffey-dev · 0 comments

jcoffey-dev commented

2026-09-15 17:52:07 +00:00

Owner

The README goes from 491 lines to 114. Its own line 59 said it was for people working on ihasmail, but most of it was for people running it, and that material already lives on docs.ihasmail.org.

Depends on Coffey-Labs/ihasmail.org#94, which adds to the docs what only the README had: the published image and its tags, the weekly release schedule, STALWART_ADMIN_URL and adminUrl, BASE_PATH, and the Administration sections. Merge and deploy that first so the links land on real content.

Where each section went:

Section	Now in
Container images, weekly release note	Installing › Using the published image (#94)
Running immutably	Configuring and Running immutably (already there)
Several Stalwart servers, admin URL	Configuring (admin URL added in #94)
Settings policy, all three sections	Configuring (already there)
Deploying	Installing › Redeploying later (already there)
Stalwart 0.16.21 / 0.16.22 changes	KNOWN-ISSUES.md (0.16.21's four changes added here; 0.16.22 was already there)
Architecture, the mock and its switches, version numbers, dev commands	CONTRIBUTING.md › Development Setup
Feature bullets	One line each, linking to FEATURES.md
Relicensing history	Dropped; the `SOURCE_URL` note stays

Wording:

Removed the comparisons to another product from the README pitch, the feature list and CONTRIBUTING.md.
The #quick-start-docker anchor that ROADMAP.md links to is kept.
Every relative link in README.md and CONTRIBUTING.md resolves.

Merged 2026-09-15 as coffey-labs/ihasmail@a7d36e1962

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

The README goes from 491 lines to 114. Its own line 59 said it was for people working *on* ihasmail, but most of it was for people running it, and that material already lives on docs.ihasmail.org. **Depends on Coffey-Labs/ihasmail.org#94**, which adds to the docs what only the README had: the published image and its tags, the weekly release schedule, `STALWART_ADMIN_URL` and `adminUrl`, `BASE_PATH`, and the Administration sections. Merge and deploy that first so the links land on real content. **Where each section went:** | Section | Now in | | --- | --- | | Container images, weekly release note | Installing › Using the published image (#94) | | Running immutably | Configuring and Running immutably (already there) | | Several Stalwart servers, admin URL | Configuring (admin URL added in #94) | | Settings policy, all three sections | Configuring (already there) | | Deploying | Installing › Redeploying later (already there) | | Stalwart 0.16.21 / 0.16.22 changes | KNOWN-ISSUES.md (0.16.21's four changes added here; 0.16.22 was already there) | | Architecture, the mock and its switches, version numbers, dev commands | CONTRIBUTING.md › Development Setup | | Feature bullets | One line each, linking to FEATURES.md | | Relicensing history | Dropped; the `SOURCE_URL` note stays | **Wording:** - Removed the comparisons to another product from the README pitch, the feature list and CONTRIBUTING.md. - The `#quick-start-docker` anchor that ROADMAP.md links to is kept. - Every relative link in README.md and CONTRIBUTING.md resolves. **Merged** 2026-09-15 as coffey-labs/ihasmail@a7d36e196249 <sub>Rebuilt from: GH Archive, 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#368