mirror of
https://github.com/open-jarvis/OpenJarvis.git
synced 2026-07-27 21:05:34 +00:00
68b27654a8
Addresses feedback from our Discord admin curating #config-showcase: the
existing docs land non-technical users straight into Tutorials, which
are script-first and TOML-heavy ("standalone script you can run
immediately, a TOML recipe, a detailed walkthrough"). For a curious-
but-non-technical reader trying to decide whether OpenJarvis is worth
their weekend, that's the wrong first contact — they bounce before they
ever see what the framework can do for them.
This PR inserts a new Showcase tier *above* Tutorials in the docs
information architecture. Each entry is outcome-first: hook sentence,
hero screenshot, 2-3 short paragraphs of personal context, then a
"How I set this up →" link that lands on the relevant Tutorial /
User Guide. The Showcase is the funnel; Tutorials are the build steps.
Five inaugural entries — drafted to be paste-ready for #config-showcase:
- showcase/morning-brief.md — Slack/email/GitHub overnight digest
- showcase/persistent-memory.md — SOUL.md/MEMORY.md/USER.md story
- showcase/cost-savings.md — the public leaderboard as motivation
- showcase/discord-companion.md — DM Jarvis from anywhere
- showcase/coding-assistant.md — code review on an airplane
Plus the contributor template and an assets directory:
- showcase/CONTRIBUTING.md — format skeleton + editorial conventions
(screenshot specs, what to redact, tone)
- assets/showcase/README.md — asset directory conventions
- assets/showcase/*.png — placeholder hero screenshots (1600x1000,
6 KB each, dark gradient) so the gallery
renders cleanly before community
submissions populate real screenshots
Information-architecture changes:
- mkdocs.yml — insert "Showcase" tier between Getting Started and
Tutorials. Funnel order is now: land → "what's possible?" → "build it."
- docs/index.md — new hero card directly under the tagline, pointing to
the Showcase. The research-framework framing stays, but no longer
occupies the first scroll-fold.
CSS:
- docs/stylesheets/extra.css — `.showcase-screenshot` class adds rounded
corners + subtle border so hero images (placeholder or real) read as
intentional rather than as broken-image artifacts.
Validation:
- `uv run mkdocs build` (CI mode) succeeds.
- `uv run mkdocs build --strict` produces zero showcase-specific
warnings. The 18 remaining strict-mode warnings are all pre-existing
on main (`desktop-auto-update.md`, `telemetry.md`, griffe parser
warnings on existing source, mkdocs_autorefs cross-reference issues).
Explicit non-goals (deferred to follow-up PRs in the showcase-tier
roadmap):
- `jarvis showcase` CLI for personal recaps (PR #2)
- Showcase-aligned recipes in `src/openjarvis/recipes/data/` so
"How I set this up →" links into 2-command installs (PR #2)
- Automated screenshot regeneration via Playwright on release tags (PR #3)
- Replacing placeholder PNGs with real screenshots — that happens
organically as community contributors and team members submit their
own setups (see CONTRIBUTING.md for the format)
Co-authored-by: krypticmouse <herumbshandilya123@gmail.com>
Co-authored-by: Claude Opus 4.7 <noreply@anthropic.com>
203 lines
6.1 KiB
YAML
203 lines
6.1 KiB
YAML
site_name: OpenJarvis
|
|
site_url: https://open-jarvis.github.io/OpenJarvis/
|
|
site_description: Personal AI, On Personal Devices
|
|
site_author: OpenJarvis Contributors
|
|
repo_url: https://github.com/open-jarvis/OpenJarvis
|
|
repo_name: open-jarvis/OpenJarvis
|
|
edit_uri: edit/main/docs/
|
|
|
|
copyright: Copyright © 2026 OpenJarvis Contributors
|
|
|
|
theme:
|
|
name: material
|
|
custom_dir: docs/overrides
|
|
language: en
|
|
font:
|
|
text: Georgia
|
|
code: JetBrains Mono
|
|
features:
|
|
- navigation.tabs
|
|
- navigation.tabs.sticky
|
|
- navigation.sections
|
|
- navigation.top
|
|
- navigation.indexes
|
|
- navigation.footer
|
|
- search.suggest
|
|
- search.highlight
|
|
- content.code.copy
|
|
- content.code.annotate
|
|
- content.tabs.link
|
|
- toc.follow
|
|
palette:
|
|
- media: "(prefers-color-scheme: light)"
|
|
scheme: default
|
|
primary: custom
|
|
accent: blue
|
|
toggle:
|
|
icon: material/brightness-7
|
|
name: Switch to dark mode
|
|
- media: "(prefers-color-scheme: dark)"
|
|
scheme: slate
|
|
primary: custom
|
|
accent: blue
|
|
toggle:
|
|
icon: material/brightness-4
|
|
name: Switch to light mode
|
|
icon:
|
|
repo: fontawesome/brands/github
|
|
|
|
extra_css:
|
|
- stylesheets/extra.css
|
|
- https://cdn.jsdelivr.net/npm/@docsearch/css@3
|
|
|
|
plugins:
|
|
- search:
|
|
separator: '[\s\-\._]+'
|
|
- gen-files:
|
|
scripts:
|
|
- docs/gen_ref_pages.py
|
|
- docs/gen_install_script.py
|
|
- literate-nav:
|
|
nav_file: SUMMARY.md
|
|
- mkdocstrings:
|
|
default_handler: python
|
|
handlers:
|
|
python:
|
|
paths: [src]
|
|
options:
|
|
show_source: true
|
|
show_root_heading: true
|
|
show_root_full_path: false
|
|
show_category_heading: true
|
|
show_symbol_type_heading: true
|
|
show_symbol_type_toc: true
|
|
members_order: source
|
|
docstring_style: numpy
|
|
docstring_section_style: spacy
|
|
merge_init_into_class: true
|
|
show_signature_annotations: true
|
|
separate_signature: true
|
|
signature_crossrefs: true
|
|
show_if_no_docstring: false
|
|
inherited_members: false
|
|
filters:
|
|
- "!^_"
|
|
- "^__init__$"
|
|
- "^__all__$"
|
|
|
|
markdown_extensions:
|
|
- abbr
|
|
- admonition
|
|
- attr_list
|
|
- def_list
|
|
- footnotes
|
|
- md_in_html
|
|
- tables
|
|
- toc:
|
|
permalink: true
|
|
toc_depth: 3
|
|
- pymdownx.betterem:
|
|
smart_enable: all
|
|
- pymdownx.caret
|
|
- pymdownx.details
|
|
- pymdownx.emoji:
|
|
emoji_index: !!python/name:material.extensions.emoji.twemoji
|
|
emoji_generator: !!python/name:material.extensions.emoji.to_svg
|
|
- pymdownx.highlight:
|
|
anchor_linenums: true
|
|
line_spans: __span
|
|
pygments_lang_class: true
|
|
- pymdownx.inlinehilite
|
|
- pymdownx.keys
|
|
- pymdownx.mark
|
|
- pymdownx.smartsymbols
|
|
- pymdownx.snippets:
|
|
auto_append:
|
|
- docs/includes/abbreviations.md
|
|
check_paths: false
|
|
- pymdownx.superfences:
|
|
custom_fences:
|
|
- name: mermaid
|
|
class: mermaid
|
|
format: !!python/name:pymdownx.superfences.fence_code_format
|
|
- pymdownx.tabbed:
|
|
alternate_style: true
|
|
- pymdownx.tasklist:
|
|
custom_checkbox: true
|
|
- pymdownx.tilde
|
|
|
|
extra_javascript:
|
|
- javascripts/leaderboard.js
|
|
- https://cdn.jsdelivr.net/npm/@docsearch/js@3
|
|
- javascripts/docsearch-init.js
|
|
|
|
extra:
|
|
version:
|
|
default: v1.0.0
|
|
algolia:
|
|
app_id: "" # Fill after DocSearch approval
|
|
api_key: "" # Search-only key
|
|
index_name: "" # e.g. "openjarvis"
|
|
social:
|
|
- icon: fontawesome/brands/github
|
|
link: https://github.com/open-jarvis/OpenJarvis
|
|
|
|
nav:
|
|
- Home: index.md
|
|
- Getting Started:
|
|
- Installation: getting-started/installation.md
|
|
- macOS Guide: getting-started/macos.md
|
|
- Quick Start: getting-started/quickstart.md
|
|
- Code Snippets: getting-started/snippets.md
|
|
- Configuration: getting-started/configuration.md
|
|
- Showcase:
|
|
- Overview: showcase/index.md
|
|
- Morning Brief: showcase/morning-brief.md
|
|
- Memory That Doesn't Reset: showcase/persistent-memory.md
|
|
- Track Your Savings: showcase/cost-savings.md
|
|
- Discord Companion: showcase/discord-companion.md
|
|
- Offline Code Reviewer: showcase/coding-assistant.md
|
|
- Contributing: showcase/CONTRIBUTING.md
|
|
- Tutorials:
|
|
- Overview: tutorials/index.md
|
|
- Deep Research Assistant: tutorials/deep-research.md
|
|
- Scheduled Personal Ops: tutorials/scheduled-ops.md
|
|
- Messaging Hub: tutorials/messaging-hub.md
|
|
- Code Companion: tutorials/code-companion.md
|
|
- Architecture:
|
|
- Overview: architecture/overview.md
|
|
- Intelligence: architecture/intelligence.md
|
|
- Engine: architecture/engine.md
|
|
- Agents: architecture/agents.md
|
|
- Tools & Memory: architecture/memory.md
|
|
- Learning: architecture/learning.md
|
|
- Query Flow: architecture/query-flow.md
|
|
- Security: architecture/security.md
|
|
- Design Principles: architecture/design-principles.md
|
|
- API Reference: api-reference/
|
|
- User Guide:
|
|
- CLI: user-guide/cli.md
|
|
- Pearl CLI: user-guide/pearl.md
|
|
- Pearl Mining: user-guide/mining.md
|
|
- Pearl Mining on Apple Silicon: user-guide/mining-apple-silicon.md
|
|
- Python SDK: user-guide/python-sdk.md
|
|
- Morning Digest: user-guide/morning-digest.md
|
|
- Deep Research: user-guide/deep-research.md
|
|
- Code Assistant: user-guide/code-assistant.md
|
|
- Scheduled Monitor: user-guide/scheduled-monitor.md
|
|
- Simple Chat: user-guide/chat-simple.md
|
|
- Agents: user-guide/agents.md
|
|
- Channels & Connectors: user-guide/channels-and-connectors.md
|
|
- Tools: user-guide/tools.md
|
|
- Memory: user-guide/memory.md
|
|
- External MCP Servers: user-guide/mcp-external-servers.md
|
|
- Scheduler: user-guide/scheduler.md
|
|
- Telemetry: user-guide/telemetry.md
|
|
- Security: user-guide/security.md
|
|
- LLM-guided spec search: user-guide/llm-guided-spec-search.md
|
|
- Leaderboard: leaderboard.md
|
|
- Roadmap: development/roadmap.md
|
|
- Development:
|
|
- Mining: development/mining.md
|
|
- Pearl Model Enablement: development/pearl-model-enablement.md
|