From c762efe1c97ae9df8e2f729e0488b9a400876d24 Mon Sep 17 00:00:00 2001 From: Alexandre Teixeira Date: Mon, 27 Jul 2026 16:45:48 +0100 Subject: [PATCH] docs: replace detailed roadmap with directional overview --- .github/ISSUE_TEMPLATE/feature_request.yml | 4 +- README.md | 2 +- ROADMAP.md | 118 +++++++----------- tests/test_provider_endpoints_url_building.py | 6 +- 4 files changed, 49 insertions(+), 81 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 4ee603ee9..ae8d18f3f 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -8,8 +8,8 @@ body: value: | **Before submitting:** search [open issues](https://github.com/odysseus-dev/odysseus/issues) and [discussions](https://github.com/odysseus-dev/odysseus/discussions) first. - Feature requests that duplicate [ROADMAP.md](https://github.com/odysseus-dev/odysseus/blob/main/ROADMAP.md) - or an existing open issue will be closed as duplicates. + The [roadmap](https://github.com/odysseus-dev/odysseus/blob/main/ROADMAP.md) is directional rather than a complete backlog. + Feature requests that duplicate an existing issue or accepted proposal may be closed as duplicates. If your idea needs community input before it becomes a concrete proposal, start a [discussion](https://github.com/odysseus-dev/odysseus/discussions/categories/ideas) instead. diff --git a/README.md b/README.md index 705ec6b68..b8d2017d7 100644 --- a/README.md +++ b/README.md @@ -55,7 +55,7 @@ A full hover-to-play tour lives on the landing page: [`docs/index.html`](docs/in ## Contributing -Help is welcome. The best entry points are fresh-install testing, provider setup bugs, mobile/editor polish, docs, and small focused refactors. See [CONTRIBUTING.md](CONTRIBUTING.md) and [ROADMAP.md](ROADMAP.md). +Help is welcome. The best entry points are fresh-install testing, provider setup bugs, mobile/editor polish, documentation, and small focused refactors. See [CONTRIBUTING.md](CONTRIBUTING.md), the [public roadmap](ROADMAP.md), and the open [GitHub issues](https://github.com/odysseus-dev/odysseus/issues). ## Security diff --git a/ROADMAP.md b/ROADMAP.md index f5c47ae18..bcf0c155c 100644 --- a/ROADMAP.md +++ b/ROADMAP.md @@ -1,87 +1,55 @@ -# Roadmap / Help Wanted +# Roadmap -Odysseus is on a voyage, but not home yet. It works great for me (lol), but this ship is moving fast and feedback/help would be appreciated! (I don't know what I'm doing, help). +This document provides a high-level view of the areas Odysseus is currently improving. -If you see weird CSS, strange layout behavior, or a suspiciously murky corner of -the codebase, you are probably right to stay away. +It is directional rather than exhaustive. Priorities may change as the project evolves, defects are discovered, and maintainers learn more from implementation work and user feedback. -## High Priority +For current implementation work, see the open [GitHub issues](https://github.com/odysseus-dev/odysseus/issues). Accepted behaviour should be documented in the repository alongside the code. -- SQUASH BUGS -- Fresh install smoke tests on Linux, macOS, and Windows. Docker, native Python, - and WSL all need coverage. +## Current priorities -- Integration audit: do integrations even work? Confirm what works, what needs setup docs, and what should be removed or hidden. -- Cookbook reliability on other computers. This is probably the area most likely to need work across different machines, GPUs, drivers, shells, and Python environments. -- Cookbook SGLang support across platforms. Make sure SGLang setup/serve works - predictably on Linux, Windows/WSL, macOS where possible, Docker, and common - NVIDIA/AMD hardware paths. -- Deep Research model presets by hardware. Recommend approved model/parameter - profiles for small, medium, and large local setups so people with different - hardware can use Deep Research without guessing. Surface this either in Deep - Research settings or as a Cookbook scan/dropdown suggestion. -- Cookbook model scan/download ranking. Prioritize newer architectures and - better hardware-fit models instead of scoring everything almost the same. - Ranking should account for architecture age, quant format, VRAM/RAM fit, - backend support, vision/mmproj requirements, and likely serve reliability. -- Cookbook error feedback and logging. Failed downloads, dependency installs, - preflights, and serve jobs should show the actual command/output/error in the - UI, with copyable logs and clear next steps instead of just "crashed". -- Agent prompt/context bloat. Agent mode is too heavy for smaller local models: - tool schemas, skills, memory, documents, and instructions can eat the context - before the user request really starts. We need slimmer prompts, better tool - selection, smaller default tool sets, and clearer guidance for models with - 4k/8k/16k context windows. -- Local model speculative decoding support. For Odysseus-tuned local models, - plan to ship or recommend a small same-tokenizer draft model when the serving - backend supports it. Early vLLM testing showed a generic `Qwen3-0.6B` draft - beside `Qwen3-8B` can materially reduce wall time, while an unsupported - DSpark conversion performed poorly. Treat this as a supported draft-model lane - first; keep MTP-specific packaging as future work only when the architecture - and runtime support are real. Judge this by time-to-success, tool correctness, - grammar, and unchanged target output, not tokens/sec alone. -- Skill/tool prompt-injection audit. User-editable skills, notes, documents, - fetched pages, and memories should be treated as untrusted data. Keep testing - whether models follow malicious instructions from those surfaces. -- Better degraded-state reporting for ChromaDB, SearXNG, email, ntfy, and provider probes. -- Email performance audit. Fetching, searching, opening, deleting, and sending - email can feel slow, especially over IMAP/SMTP providers with high latency. - Need someone who knows mail performance to profile the current flow, identify - whether the bottleneck is IMAP folder select/fetch, cache invalidation, - attachment/body loading, SMTP handshakes, or frontend refresh behavior, then - propose safer caching/prefetch/batching without breaking multi-account state. -- Provider setup/probing audit for Anthropic, Gemini, Groq, xAI, OpenRouter, OpenAI, and DeepSeek. +### Reliability and setup -## Refactor Targets -- CSS cleanup. `static/style.css` basically Calypso's island atm. -- Tour core helper. The onboarding tours have too much copy-pasted scaffolding; promote a shared `tour-core.js` helper before adding more tours. -- Modal/window positioning cleanup. Some window controls have improved, but the - underlying popup/dropdown/fixed-position behavior is still too fragile. -- Mobile media override discoverability. A lot of "CSS did not move" bugs are mobile `@media` overrides of the same selector; comments or linting around desktop/mobile paired rules would help. -- Dead code pass for old routes, stale feature flags, and unused UI states. +- Improve fresh-install and smoke-test coverage across supported environments. +- Make provider setup, probing, and failure states more predictable. +- Improve Cookbook reliability across hardware, operating systems, drivers, shells, and serving backends. +- Improve degraded-state reporting and recovery guidance when optional services are unavailable. -## Frontend +### Local model workflows -- Expand the Editor for quicker, more robust everyday use. Better file/document - handling, smoother window behavior, clearer save/export flows, stronger image - editing affordances, and fewer brittle edge cases. -- Better AI integration for Notes and Todos. Notes should be easier for the - agent to read, update, summarize, and turn into actions. Todos should be - assignable to an agent from the UI, possibly through a button, task action, - or dedicated skill/tool flow. -- Mobile gallery/editor polish. Easier to launch/download inpaint model or any missing pieces. -- Accessibility pass: keyboard navigation, focus states, contrast, reduced motion. -- Improve empty states and error messages on fresh installs. -- Tighten first-run setup, hints, and tours so they do not repeat or fight each other. -- Vendor CDN assets eventually for a more fully self-hosted/offline mode. +- Improve hardware-aware model recommendations and compatibility guidance. +- Evaluate serving optimizations, including speculative decoding, through reproducible benchmarks. +- Improve installation, preflight checks, logging, and error reporting for local model serving. +- Reduce prompt and context overhead for smaller local models. -## Backend +### Safety and resilience -- More tests around endpoint probing and provider setup. -- Better task scheduler defaults and visibility. -- Backup/restore guide and helper flow for `data/`. -- Security hardening around admin-only tools and clear docs for their risk. +- Continue hardening tool execution, filesystem access, credentials, networking, and destructive operations. +- Treat content from documents, notes, memories, skills, and fetched pages as potentially untrusted. +- Improve security-focused regression coverage and operational guidance. +- Review integrations that expand access to sensitive data or privileged operations. -## Not The Focus Right Now +### Product usability -I prob shouldnt add more themes. +- Improve first-run setup, onboarding, hints, and tours. +- Improve accessibility, keyboard navigation, focus behaviour, contrast, and reduced-motion support. +- Improve empty states, error messages, and recovery paths. +- Strengthen Notes, Todos, Editor, mobile, and everyday workspace flows. + +### Architecture and maintainability + +- Reduce duplication and technical debt through focused, reviewable refactors. +- Improve subsystem documentation as behaviour and architecture become stable. +- Remove stale code, obsolete feature flags, and unsupported integrations. +- Keep implementation decisions grounded in current code and verified behaviour. + +## Tracking work + +Concrete implementation tasks, defects, proposals, and technical investigations are tracked in: + +- [GitHub Issues](https://github.com/odysseus-dev/odysseus/issues) +- [Contributing Guide](CONTRIBUTING.md) + +Maintainers may use additional private coordination tools for ownership, planning, and unresolved decisions. + +This roadmap is not a complete backlog or a guarantee that a particular item will be delivered. diff --git a/tests/test_provider_endpoints_url_building.py b/tests/test_provider_endpoints_url_building.py index 56d129e1c..7ddbe2ba8 100644 --- a/tests/test_provider_endpoints_url_building.py +++ b/tests/test_provider_endpoints_url_building.py @@ -1,8 +1,8 @@ """Provider endpoint URL-building tests. -Covers ``build_chat_url`` and ``build_models_url`` for every provider named in -ROADMAP.md: Anthropic, Gemini, Groq, xAI, OpenRouter, OpenAI, DeepSeek, Ollama -(local + cloud). +Covers ``build_chat_url`` and ``build_models_url`` for the provider families +exercised by this module: Anthropic, Gemini, Groq, xAI, OpenRouter, OpenAI, +DeepSeek, and Ollama (local and cloud). """ import pytest