Repository navigation
docs: full documentation for imapkit.com - #93
Merged
Merged
Conversation
- The imapkit command prints the port it really listens on (also for -p 0), secureConnection from a --config file switches the default port to 993, the REST host of a config file shows in the startup line, and an unknown plugin or quirk name ends with "Failed to start ImapKit" instead of a stack trace. - A graceful shutdown ends open GET /v1/events streams, so it no longer waits for their clients forever. - ControlRoute, RouteRequest, FlagMode, UidMode and UidValidityOptions are exported as types. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The site has 39 pages: getting started, guides (writing client tests, storage, authentication, strict by design, multiple sessions, other languages), fault injection, the control API, the REST API, every extension, a reference (server options, server API, custom plugins, migrating from 4.x, known issues) and contributing. Every page was checked against the source and its examples and transcripts come from real runs. The homepage and the graphics are new SVG drawings. README, the CLI help text, CLAUDE.md and a few code comments were corrected where the review found them out of date. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The full documentation site: 39 pages covering getting started, guides, fault injection, the control API, the REST API, every extension, a reference and contributing. It also adds a new homepage and original SVG graphics.
Every page was checked against the source by a separate review pass, and the examples and transcripts come from real runs against ImapKit.
The review also found a few small issues, fixed in a separate
fix:commit:-p 0secureConnectionin a config file switches the default port to 993README, help text and comment corrections are in the docs commit.
🤖 Generated with Claude Code