97 lines
2.9 KiB
Markdown
97 lines
2.9 KiB
Markdown
# Scope and non-goals
|
|
|
|
## In scope for the first complete release
|
|
|
|
### Knowledge management
|
|
|
|
- Hierarchical pages and collections.
|
|
- Markdown editing and safe rendering.
|
|
- Stable internal links.
|
|
- Tags, backlinks, favorites and recent pages.
|
|
- Templates and typed document metadata.
|
|
- Draft recovery and optimistic-concurrency conflict handling.
|
|
- Immutable revisions, comparison and restoration.
|
|
- Trash, retention and controlled purge.
|
|
- Permission-aware full-text and fuzzy title search.
|
|
- Attachments with deduplication and integrity hashes.
|
|
- Durable Markdown/project export.
|
|
|
|
### Structured project knowledge
|
|
|
|
- Project dossiers and lifecycle status.
|
|
- Current-state summary.
|
|
- Technology and external-link metadata.
|
|
- Project timeline entries.
|
|
- Milestones.
|
|
- Linked project documents.
|
|
- Architecture Decision Records.
|
|
- Runbook profiles and validation dates.
|
|
- Compact project-context assembly.
|
|
|
|
### Migration and operations
|
|
|
|
- Read-only LeafWiki discovery.
|
|
- Deterministic preflight.
|
|
- Idempotent import.
|
|
- Validation report and rollback by import.
|
|
- PostgreSQL migrations.
|
|
- Backup, retention, clean restore and integrity validation.
|
|
- Health endpoints, structured logs and audit trail.
|
|
- Docker Compose deployment on Unraid.
|
|
- Reverse-proxy documentation.
|
|
|
|
### Integration surface
|
|
|
|
- Versioned REST API.
|
|
- OpenAPI description.
|
|
- Scoped service accounts.
|
|
- Revocable one-time-display API tokens.
|
|
- Permission-filtered search, pages, projects and context.
|
|
- Controlled write endpoints with optimistic concurrency.
|
|
- Transactional outbox.
|
|
|
|
## Explicit non-goals
|
|
|
|
The first release does **not** include:
|
|
|
|
- an MCP server or MCP transport;
|
|
- an embedded chatbot or autonomous AI agent;
|
|
- automatic code execution or shell execution from runbooks;
|
|
- live repository write access;
|
|
- automatic Gitea synchronization;
|
|
- public multi-tenant SaaS hosting;
|
|
- real-time collaborative editing;
|
|
- native mobile applications;
|
|
- a marketplace or plugin runtime;
|
|
- arbitrary user-defined server-side scripts;
|
|
- Elasticsearch, Redis, Kafka, Kubernetes or microservices;
|
|
- public anonymous publishing by default;
|
|
- a full Notion-style relational database builder;
|
|
- spreadsheet, whiteboard or presentation editing;
|
|
- OCR of imported documents;
|
|
- secrets management or password-vault behavior.
|
|
|
|
## Deferred candidates
|
|
|
|
These may be considered only after release evidence and a new milestone/ADR:
|
|
|
|
- a separate MCP server;
|
|
- read-only Gitea document synchronization;
|
|
- semantic search with embeddings;
|
|
- public share links with expiry;
|
|
- additional workspaces;
|
|
- WebAuthn/passkeys;
|
|
- external identity providers;
|
|
- scheduled page review reminders;
|
|
- offline-first editing;
|
|
- document-level approval workflows.
|
|
|
|
## Scope-change rule
|
|
|
|
A new feature cannot displace a P0 acceptance criterion. It must be:
|
|
|
|
1. added to the backlog;
|
|
2. assigned a priority and milestone;
|
|
3. evaluated for security, migration and operational impact;
|
|
4. accepted through an ADR when it changes a core boundary.
|