Compare commits

...
2 Commits
Author SHA1 Message Date
Squid 0576e71525 Added some more planning files 2026-11-18 18:52:25 +01:00
Squid e17961e49e Structured plan folder 2026-11-18 18:44:18 +01:00
25 changed files with 277 additions and 0 deletions

No files matched your search

+18
View File
@@ -0,0 +1,18 @@
# 01 — Vision
## Product identity
Moorly Mail is a modern desktop email client intended to make email simple, fast, and enjoyable, with a clean interface and thoughtful features.
## Proposed direction
This statement captures the current high-level product intent. It is not a detailed specification or an approval of any particular design or technology.
## Open questions
- What user needs and priorities should most shape the product?
- What does “simple, fast, and enjoyable” mean in practice?
## Confirmed decisions
No additional decisions are recorded here. Approved choices belong in [decisions/](decisions/).
+15
View File
@@ -0,0 +1,15 @@
# 02 — Features
This document is a high-level index of feature direction, not a requirements specification. Keep detailed area-specific planning in the relevant directory and link to it here when useful.
## Proposed ideas
No ideas recorded yet.
## Candidates
No candidates recorded yet. Candidates are under consideration, not commitments.
## Confirmed
No features have been recorded as confirmed. Add an item here only after approval; put the decision and rationale in [decisions/](decisions/).
+23
View File
@@ -0,0 +1,23 @@
# Planning
This directory contains Moorly Mail's modular planning documents. Keep ideas and candidates distinct from confirmed decisions; a proposal is not an approval. Record approved choices in [decisions/](decisions/) and link to them rather than repeating them elsewhere.
## Areas
- [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.
- [Decisions](decisions/README.md) — approved decisions and their rationale.
## Planning documents
- [01 — Vision](01-VISION.md) — product purpose and direction.
- [02 — Features](02-FEATURES.md) — feature ideas and their current status.
Keep documents focused on their area. Link to the source document when information is relevant elsewhere instead of copying it. Do not add detailed technical specifications until they are requested and the relevant direction is approved.
+3
View File
@@ -0,0 +1,3 @@
# Architecture
Track product-wide architectural questions and proposals here. Do not treat a proposal as an approved design; record approved decisions in [decisions](../decisions/).
+15
View File
@@ -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/).
+15
View File
@@ -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/).
+15
View File
@@ -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/).
+15
View File
@@ -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/).
+10
View File
@@ -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/).
+3
View File
@@ -0,0 +1,3 @@
# Crates
Track Rust crate candidates and their possible responsibilities here. Mentioning a crate is not an endorsement or a final dependency choice; record approved choices in [decisions](../decisions/).
+11
View File
@@ -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.
+11
View File
@@ -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/).
+11
View File
@@ -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/).
+11
View File
@@ -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/).
+5
View File
@@ -0,0 +1,5 @@
# Decisions
This area is the source of truth for explicitly approved decisions and their rationale. Keep proposed ideas and candidates in their respective planning documents; link here only when a choice is approved.
No decisions recorded yet.
+15
View File
@@ -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/).
+15
View File
@@ -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/).
+9
View File
@@ -0,0 +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.
+15
View File
@@ -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/).
+15
View File
@@ -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/).
+15
View File
@@ -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/).
+3
View File
@@ -0,0 +1,3 @@
# GUI
Plan interface concepts, interaction patterns, and visual direction here. Separate proposals from approved decisions and link to relevant [decision records](../decisions/).
+3
View File
@@ -0,0 +1,3 @@
# Risks
Track project risks, assumptions, and potential mitigations here. Link to related area documents instead of repeating their content.
+3
View File
@@ -0,0 +1,3 @@
# Roadmap
Track possible sequencing and milestones here. Treat roadmap items as proposals until approved; link to the relevant feature and decision documents.
+3
View File
@@ -0,0 +1,3 @@
# Security
Track security goals, considerations, and open questions here. Keep proposals distinct from confirmed requirements and decisions.