From 0576e715256c7651df1918eeacda51d7f3c357bc Mon Sep 17 00:00:00 2001 From: squid Date: Wed, 18 Nov 2026 18:52:25 +0100 Subject: [PATCH] Added some more planning files --- plan/README.md | 2 ++ plan/authentication/CREDENTIAL-STORAGE.md | 15 +++++++++++++++ plan/authentication/GOOGLE.md | 15 +++++++++++++++ plan/authentication/MICROSOFT.md | 15 +++++++++++++++ plan/authentication/OAUTH2.md | 15 +++++++++++++++ plan/authentication/OVERVIEW.md | 10 ++++++++++ plan/database/CANDIDATES.md | 11 +++++++++++ plan/database/REQUIREMENTS.md | 11 +++++++++++ plan/database/SECURITY.md | 11 +++++++++++ plan/database/SQLITE.md | 11 +++++++++++ plan/email/IMAP.md | 15 +++++++++++++++ plan/email/MIME.md | 15 +++++++++++++++ plan/email/README.md | 6 ++++++ plan/email/SEARCH.md | 15 +++++++++++++++ plan/email/SMTP.md | 15 +++++++++++++++ plan/email/SYNCHRONIZATION.md | 15 +++++++++++++++ 16 files changed, 197 insertions(+) create mode 100644 plan/authentication/CREDENTIAL-STORAGE.md create mode 100644 plan/authentication/GOOGLE.md create mode 100644 plan/authentication/MICROSOFT.md create mode 100644 plan/authentication/OAUTH2.md create mode 100644 plan/authentication/OVERVIEW.md create mode 100644 plan/database/CANDIDATES.md create mode 100644 plan/database/REQUIREMENTS.md create mode 100644 plan/database/SECURITY.md create mode 100644 plan/database/SQLITE.md create mode 100644 plan/email/IMAP.md create mode 100644 plan/email/MIME.md create mode 100644 plan/email/SEARCH.md create mode 100644 plan/email/SMTP.md create mode 100644 plan/email/SYNCHRONIZATION.md diff --git a/plan/README.md b/plan/README.md index c877ad4..84ac74f 100644 --- a/plan/README.md +++ b/plan/README.md @@ -6,8 +6,10 @@ This directory contains Moorly Mail's modular planning documents. Keep ideas and - [GUI](gui/README.md) — interface concepts, interaction patterns, and visual direction. - [Architecture](architecture/README.md) — product-wide structure and architectural questions. +- [Database](database/REQUIREMENTS.md) — data requirements, candidates, and database-specific considerations. - [Crates](crates/README.md) — Rust crate options and responsibilities; listing a crate here does not approve its use. - [Email](email/README.md) — email behavior, workflows, and protocol-related product requirements. +- [Authentication](authentication/OVERVIEW.md) — authentication concepts, provider-specific planning, and credential-storage questions. - [Security](security/README.md) — security goals, considerations, and open questions. - [Risks](risks/README.md) — project risks, assumptions, and potential mitigations. - [Roadmap](roadmap/README.md) — possible sequencing and milestones. diff --git a/plan/authentication/CREDENTIAL-STORAGE.md b/plan/authentication/CREDENTIAL-STORAGE.md new file mode 100644 index 0000000..b2f9843 --- /dev/null +++ b/plan/authentication/CREDENTIAL-STORAGE.md @@ -0,0 +1,15 @@ +# Credential storage + +Plan credential-storage requirements, risks, and options here. No storage mechanism is approved by this document. + +## Proposed ideas + +No ideas recorded yet. + +## Candidates + +No candidates recorded yet. + +## Confirmed decisions + +No decisions recorded. Add approved choices to [decisions](../decisions/). diff --git a/plan/authentication/GOOGLE.md b/plan/authentication/GOOGLE.md new file mode 100644 index 0000000..d17ffdd --- /dev/null +++ b/plan/authentication/GOOGLE.md @@ -0,0 +1,15 @@ +# Google authentication + +Planning notes for Google account authentication. Provider-specific details remain open until explicitly approved. + +## Proposed ideas + +No ideas recorded yet. + +## Candidates + +No candidates recorded yet. + +## Confirmed decisions + +No decisions recorded. Add approved choices to [decisions](../decisions/). diff --git a/plan/authentication/MICROSOFT.md b/plan/authentication/MICROSOFT.md new file mode 100644 index 0000000..d3d05df --- /dev/null +++ b/plan/authentication/MICROSOFT.md @@ -0,0 +1,15 @@ +# Microsoft authentication + +Planning notes for Microsoft account authentication. Provider-specific details remain open until explicitly approved. + +## Proposed ideas + +No ideas recorded yet. + +## Candidates + +No candidates recorded yet. + +## Confirmed decisions + +No decisions recorded. Add approved choices to [decisions](../decisions/). diff --git a/plan/authentication/OAUTH2.md b/plan/authentication/OAUTH2.md new file mode 100644 index 0000000..fb2b219 --- /dev/null +++ b/plan/authentication/OAUTH2.md @@ -0,0 +1,15 @@ +# OAuth 2.0 + +Planning notes for OAuth 2.0-related authentication. This document does not establish OAuth 2.0 as an approved implementation choice. + +## Proposed ideas + +No ideas recorded yet. + +## Candidates + +No candidates recorded yet. + +## Confirmed decisions + +No decisions recorded. Add approved choices to [decisions](../decisions/). diff --git a/plan/authentication/OVERVIEW.md b/plan/authentication/OVERVIEW.md new file mode 100644 index 0000000..1d5b661 --- /dev/null +++ b/plan/authentication/OVERVIEW.md @@ -0,0 +1,10 @@ +# Authentication overview + +Use this area to plan authentication behavior and provider-specific requirements. The documents below are planning topics, not approval of a flow, provider, or implementation. + +- [OAuth 2.0](OAUTH2.md) — general OAuth 2.0 considerations and open questions. +- [Google](GOOGLE.md) — Google authentication planning. +- [Microsoft](MICROSOFT.md) — Microsoft authentication planning. +- [Credential storage](CREDENTIAL-STORAGE.md) — requirements and options for storing credentials. + +Keep proposals and candidates clearly labeled. Record approved choices in [decisions](../decisions/). diff --git a/plan/database/CANDIDATES.md b/plan/database/CANDIDATES.md new file mode 100644 index 0000000..3c6698a --- /dev/null +++ b/plan/database/CANDIDATES.md @@ -0,0 +1,11 @@ +# Database candidates + +Track database options considered for Moorly Mail here. A candidate is not an approved choice; document an approval and its rationale in [decisions](../decisions/). + +## Candidates + +No candidates recorded yet. + +## Confirmed choice + +No database choice recorded. diff --git a/plan/database/REQUIREMENTS.md b/plan/database/REQUIREMENTS.md new file mode 100644 index 0000000..e1b37d7 --- /dev/null +++ b/plan/database/REQUIREMENTS.md @@ -0,0 +1,11 @@ +# Database requirements + +Capture product and data requirements relevant to database planning here. Keep requirements separate from candidate technologies. + +## Proposed requirements + +No requirements recorded yet. + +## Confirmed requirements + +No confirmed requirements recorded. Approved decisions belong in [decisions](../decisions/). diff --git a/plan/database/SECURITY.md b/plan/database/SECURITY.md new file mode 100644 index 0000000..c568a05 --- /dev/null +++ b/plan/database/SECURITY.md @@ -0,0 +1,11 @@ +# Database security + +Track database-related security requirements and questions here. Keep shared security principles in [security](../security/) and link rather than duplicate them. + +## Open questions + +No questions recorded yet. + +## Confirmed decisions + +No decisions recorded. Add approved choices to [decisions](../decisions/). diff --git a/plan/database/SQLITE.md b/plan/database/SQLITE.md new file mode 100644 index 0000000..e9afa3f --- /dev/null +++ b/plan/database/SQLITE.md @@ -0,0 +1,11 @@ +# SQLite + +Planning notes for SQLite as a database candidate. This document does not approve SQLite for use. + +## Considerations + +No considerations recorded yet. + +## Status + +Candidate status has not been recorded. Track consideration in [CANDIDATES.md](CANDIDATES.md); record any approved choice in [decisions](../decisions/). diff --git a/plan/email/IMAP.md b/plan/email/IMAP.md new file mode 100644 index 0000000..2555bd7 --- /dev/null +++ b/plan/email/IMAP.md @@ -0,0 +1,15 @@ +# IMAP + +Planning notes for IMAP-related requirements and questions. Listing this protocol does not establish it as an approved implementation choice. + +## Proposed ideas + +No ideas recorded yet. + +## Candidates + +No candidates recorded yet. + +## Confirmed decisions + +No decisions recorded. Add approved choices to [decisions](../decisions/). diff --git a/plan/email/MIME.md b/plan/email/MIME.md new file mode 100644 index 0000000..a1dc5e2 --- /dev/null +++ b/plan/email/MIME.md @@ -0,0 +1,15 @@ +# MIME + +Planning notes for email message content and MIME-related requirements. + +## Proposed ideas + +No ideas recorded yet. + +## Candidates + +No candidates recorded yet. + +## Confirmed decisions + +No decisions recorded. Add approved choices to [decisions](../decisions/). diff --git a/plan/email/README.md b/plan/email/README.md index ae8ad8e..29afb9c 100644 --- a/plan/email/README.md +++ b/plan/email/README.md @@ -1,3 +1,9 @@ # Email Plan email-related product behavior, workflows, and requirements here. Keep detailed specifications scoped to this area and link to shared decisions rather than duplicating them. + +- [IMAP](IMAP.md) — IMAP-related requirements and questions; inclusion does not approve its use. +- [SMTP](SMTP.md) — SMTP-related requirements and questions; inclusion does not approve its use. +- [MIME](MIME.md) — message-content and MIME-related planning. +- [Search](SEARCH.md) — email search behavior and requirements. +- [Synchronization](SYNCHRONIZATION.md) — synchronization behavior and open questions. diff --git a/plan/email/SEARCH.md b/plan/email/SEARCH.md new file mode 100644 index 0000000..306f583 --- /dev/null +++ b/plan/email/SEARCH.md @@ -0,0 +1,15 @@ +# Email search + +Planning notes for email search behavior and requirements. + +## Proposed ideas + +No ideas recorded yet. + +## Candidates + +No candidates recorded yet. + +## Confirmed decisions + +No decisions recorded. Add approved choices to [decisions](../decisions/). diff --git a/plan/email/SMTP.md b/plan/email/SMTP.md new file mode 100644 index 0000000..e6d8946 --- /dev/null +++ b/plan/email/SMTP.md @@ -0,0 +1,15 @@ +# SMTP + +Planning notes for SMTP-related requirements and questions. Listing this protocol does not establish it as an approved implementation choice. + +## Proposed ideas + +No ideas recorded yet. + +## Candidates + +No candidates recorded yet. + +## Confirmed decisions + +No decisions recorded. Add approved choices to [decisions](../decisions/). diff --git a/plan/email/SYNCHRONIZATION.md b/plan/email/SYNCHRONIZATION.md new file mode 100644 index 0000000..66a263f --- /dev/null +++ b/plan/email/SYNCHRONIZATION.md @@ -0,0 +1,15 @@ +# Synchronization + +Planning notes for email synchronization behavior and open questions. + +## Proposed ideas + +No ideas recorded yet. + +## Candidates + +No candidates recorded yet. + +## Confirmed decisions + +No decisions recorded. Add approved choices to [decisions](../decisions/).