OpenJarvis Showcase 投稿指南：面向结果优先的本地 AI 用例社区与 Markdown 条目规范

【免费下载链接】OpenJarvisPersonal AI, On Personal Devices项目地址https://gitcode.com/gh_mirrors/op/OpenJarvis点击查看免费下载OpenJarvis 是一个运行在个人设备上的个人 AI 项目Personal AI, On Personal Devices其 Showcase 板块收录真实用户的本地 AI 配置与使用故事帮助还不熟悉该项目的读者判断它值不值得我花一个周末。本文基于仓库中的 docs/showcase/CONTRIBUTING.md完整讲解 Showcase 条目的标准格式模板、编辑规范截图规格、脱敏清单、语气红线、提交流程以及合并后的分发渠道并结合仓库中已有的五篇 showcase 条目、截图目录规范与 MkDocs 配置给出可落地的实操指引。读完后你将掌握从构思一句话 Hook、到产出合规截图、再到提交 PR 的完整投稿流程。Showcase 的定位给非技术读者看的结果展示Showcase 存在的唯一理由是帮助一位困惑、好奇、非技术背景的读者判断 OpenJarvis 是否值得付出一个周末。这个目标决定了页面上的每一项编辑决策。因此Showcase 页面不是技术文档的替代品而是技术文档的漏斗入口——每一篇条目都以结果截图 一段上下文 指向文档的短链接呈现而不是架构讲解。从仓库的 docs/showcase/index.md 可以看到 Showcase 画廊的现状目前已有 Morning Brief、Memory That Doesnt Reset、Track Your Savings、Discord Companion、Offline Code Reviewer 五个主题覆盖邮件摘要、持久记忆、本地推理成本核算、消息中枢、离线代码评审等真实使用场景在 mkdocs.yml 中这些条目与 Contributing: showcase/CONTRIBUTING.md 一起挂在 Showcase 导航组下说明投稿页是 Showcase 栏目的一等公民。标准条目模板一个 Markdown 文件搞定每篇 Showcase 条目就是一个 Markdown 文件存放在docs/showcase/your-slug.md。docs/showcase/CONTRIBUTING.md给出了完整的模板骨架下面是继承自原文档的模板全文可直接复制使用--- title: Your Title — short, capitalized description: One sentence. The hook a stranger sees in search results. --- # emoji One-sentence hook — what it does FOR you, in plain English figure markdown alt text{ .showcase-screenshot loadinglazy } figcaptionA one-sentence caption that adds context the image cant show on its own./figcaption /figure 2–3 short paragraphs of context: when do you use this, what changed for you, what the experience feels like. Concrete abstract. I read it on my phone before coffee improves morning productivity. A bulleted list of two or three CONCRETE OUTCOMES works well — your calendar, your inbox, your code. Specific verbs and proper nouns. ## Why its nice - **one-line benefit.** one or two sentences of evidence - **one-line benefit.** one or two sentences of evidence - **one-line benefit.** one or two sentences of evidence ## How I set this up → **Tutorial: name** is the closest match. → **[Recipe: name](https://github.com/open-jarvis/OpenJarvis/tree/main/src/openjarvis/recipes/data)** if you want the exact config. → **one more related doc** if the reader is going deeper.注意模板中的几个关键结构YAML front mattertitle简短且大写开头description是一句话作为陌生人在搜索结果里看到的 Hook。H1 一句话 Hook用 emoji 一句大白话说明它为你做了什么例如现有条目 ☕ Morning Brief — Jarvis reads everything overnight so I dont have to。单张 headshot 截图 figcaption截图是头条figcaption 用一句话补充图片本身无法表达的信息。23 段上下文什么时候用、用后有什么变化、体验如何。具体 抽象我喝咖啡前在手机上看它 提升了早晨生产力。23 条具体结果列表落到你的日历、收件箱、代码使用具体动词和专有名词。Why its nice每条一行收益 一两句证据。How I set this up必须以指向教程/配方/相关文档的链接收尾。仓库中 docs/showcase/morning-brief.md 是模板的最佳范本三段上下文7 点的五条 bullet 是什么、过去要 25 分钟现在只要 2 分钟三条 Why its nice零月成本、数据不出家门、会学习你的品味结尾用三个 → 链接分别指向tutorials/scheduled-ops.md、user-guide/morning-digest.md和渠道文档。图片路径与 CSS 类模板中图片引用了{ .showcase-screenshot loadinglazy }类。截图统一存放在docs/assets/showcase/your-slug.png每个条目一张主图文件名必须与条目 slug 一致。截图目录的规范见 docs/assets/showcase/README.md其中明确所有img/figure使用loadinglazy因为这些图片在画廊页首屏之外。编辑规范护栏而非规则CONTRIBUTING 明确这些是护栏不是规则有理由时可以打破但它逐条给出了可操作的判定标准以结果开头而不是以技术开头❌ Multi-channel routing with MCP-backed memory and an orchestrator agent.✅ Jarvis answers my Discord messages while I sleep.原因很直白读者还不知道orchestrator agent是什么但他们知道 Discord 消息是什么。只放一张截图让它成为头条一张大而有趣、经过裁剪的截图胜过五张小图。裁剪到只展示结果不要展示 UI 边框能用图表达的就别写那段文字。截图规格原文档 docs/assets/showcase/README.md 合并项目要求格式PNGsRGB无 alpha 通道尺寸1600×10004:2.5比 16:9 更宽避免在文档网格中被 letterbox 加黑边体积pngquant --quality 70-90 --speed 1后小于 400 KB加载条目内img/figure全部使用loadinglazy路径docs/assets/showcase/your-slug.png必须脱敏真实邮箱地址、API 密钥包括sk-、ghp_、xox、eyJ开头的令牌、个人电话号码、对话对象的头像或全名除非对方已书面同意、包含他人主目录的文件路径。必须保留模型名如 llama3.1:8b、qwen2.5:14b具有信息量、时间戳证明截图是近期真实运行、leaderboard 上的美元金额这是重点、emoji 表情、你自己的名字和头像。具体优于看起来厉害❌ Saves significant time every morning.✅ Cut my morning catch-up from 25 minutes to 2.数字、时长、美元金额、具名工具建立信任形容词不能。三段上下文足够想看更多的人会点击底部 How I set this up → 链接。Showcase 页面是通向文档的漏斗不是文档的替代品。如果你发现自己开始在 showcase 条目里解释配置那段内容应该放进被链接的教程里。仓库中 docs/showcase/coding-assistant.md 就是一个范例只讲在 SFO 到 FRA 的航班上用 40 秒、靠笔记本内置 GPU 完成五个评审意见配置细节全部交给tutorials/code-companion.md。Why its nice 写体验不写架构每条 bullet 回答的是对你来说有什么不同而不是框架的工作方式有什么不同❌ Uses local SQLite for state with WAL mode for concurrent reads.✅ I can read my own memory file in a text editor. I can delete a line and the memory is gone.文档 中的持久记忆条目正是这样写的三个纯 Markdown 文件SOUL.md/MEMORY.md/USER.md共约 6 KB无向量数据库、无嵌入缓存我可以删掉一行记忆就消失了。每条条目必须以至少一个 How I set this up → 链接结尾如果还没有对应教程链接到最接近的 User Guide: CLI并开一个 issue 说明缺少该教程——文档团队会补写。投稿流程从 fork 到 PR原文档给出的提交流程四步Fork仓库并创建分支docs/showcase-your-slug。添加你的 Markdown 文件到docs/showcase/your-slug.md截图到docs/assets/showcase/your-slug.png。在docs/showcase/index.md添加一个画廊磁贴遵循现有模式——emoji 标题 一句话摘要 :octicons-arrow-right-24: See it。仓库中 docs/showcase/index.md 的 grid cards 区块即为现有模式样板例如- :material-coffee:{ .lg .middle } **Morning Brief** --- Slack, email, GitHub, and calendar — read overnight, summarized into 5 bullets in your phone by 7am. Cuts the daily what did I miss tax to zero. [:octicons-arrow-right-24: See it](https://link.gitcode.com/i/ff296ef7709142974408ca266e862a85)开 PR标题为docs(showcase): your title。如果想要合并前的编辑反馈可以 一位维护者。注意第 3 步中磁贴链接使用的是相对当前目录的短文件名如morning-brief.md因为磁贴与条目文件位于同一个docs/showcase/目录而在条目正文内部引用图片时原模板使用的是相对该 Markdown 文件自身的../assets/showcase/your-image.png即仓库根下的docs/assets/showcase/。提交时请保持一致避免出现 404。合并之后分发渠道合并后Hannah 与文档团队会把已合并的 showcase 条目发布到#config-showcaseOpenJarvis Discord 频道。你会在帖子里被 不需要自己动手。这一约定也与 docs/showcase/index.md 中Want to talk to other people doing this?一节的说明一致#config-showcase是用户张贴、讨论个人配置的地方。有疑问、草稿或半成品想法建议在开 PR之前先丢到 Discord 的#config-showcase——在聊天里获得编辑反馈比在 PR review 里快也能省下一轮修改。与仓库其他部分的配合截图占位机制docs/assets/showcase/README.md 说明该目录在首个 PR 中不带真实图片条目会先以 MkDocs 的 broken-image 占位符渲染figcaption 仍能传达应有内容真实截图在后续 PR 中随各条目的实际配置一并补充。教程与配方的对照CONTRIBUTING 模板中的 How I set this up 链接对应docs/tutorials/下五篇教程code-companion.md、deep-research.md、messaging-hub.md、scheduled-ops.md、skills-workflow.md配方配置则位于 src/openjarvis/recipes/data 目录。导航挂载mkdocs.yml的 Showcase 导航组同时包含五篇现有条目与 Contributing 页投稿者可以在本地mkdocs serve预览画廊效果。小结投稿 OpenJarvis Showcase 的核心纪律可以用一句话概括写结果不写架构放一张大截图不堆五张小图用数字和专有名词不用形容词三段落 两个链接收工。遵循 docs/showcase/CONTRIBUTING.md 的模板与护栏任何人都能贡献出与现有五篇条目质量相当的真实使用故事帮助下一个陌生读者判断值不值得一个周末。赞分享【免费下载链接】OpenJarvisPersonal AI, On Personal Devices项目地址https://gitcode.com/gh_mirrors/op/OpenJarvis点击查看免费下载相关推荐Syft SBOM 扫描指南如何为容器镜像快速生成软件物料清单Syft SBOM 扫描指南如何为容器镜像快速生成软件物料清单 Syft 是一个命令行工具专门做一件事从容器镜像和本地目录生成 SBOM软件物料清单。供应链安全开发工具合规审计开源治理WifiPassword-Stealer安全性分析如何保护你的网络免受此类工具攻击WifiPassword Stealer安全性分析如何保护你的网络免受此类工具攻击 在数字化时代网络安全已成为每个人必须关注的重要议题。WifiPasswoawesome-react-hooks 发展方向社区投票结果分析awesome react hooks 发展方向社区投票结果分析 React Hooks 作为现代 React 开发的革命性特性已经成为函数式组件的核心能力教程文档前端上一篇Steam 创意工坊下载器 WorkshopDL 首次使用教程不装 Steam 客户端3 分钟下载第一个模组下一篇G-Helper3分钟装完的华硕笔记本控制工具创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考