From b2096a39503f8b5c9ed578c41e975badccf5265a Mon Sep 17 00:00:00 2001 From: ymote <151983+ymote@users.noreply.github.com> Date: Sat, 26 Sep 2026 15:15:42 -0700 Subject: [PATCH] Docs: point app builders to the contestant path Hackathon docs audit. README.md / README.zh-CN.md: add a "Building an OctoSense app?" note under the language switcher: a contestant does not need this library; a script app uses the `Html` / `Markdown` widgets documented in OctoScript-App-Design-Flow's SCRIPT-API, and the org profile's reading order is the way in. The rest of the README checked out (relative links resolve; the Makepad pin `47837267` matches `Cargo.lock`). Docs only. Co-Authored-By: Claude Opus 5.5 (1M context) --- README.md | 2 ++ README.zh-CN.md | 2 ++ 2 files changed, 4 insertions(+) diff --git a/README.md b/README.md index e5f0901..0065c16 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ English | [简体中文](README.zh-CN.md) +> **Building an OctoSense app?** You do not need this repository: it is a Rust library for Makepad applications (Robrix uses it). A script app shows rich text with the `Html` and `Markdown` widgets listed in [SCRIPT-API](https://github.com/OctoSense-org/OctoScript-App-Design-Flow/blob/main/docs/SCRIPT-API.md#widgets-available-to-an-app). Start from the [OctoSense organization profile](https://github.com/OctoSense-org)'s reading order: [OctoScript-App-Design-Flow `AGENTS.md`](https://github.com/OctoSense-org/OctoScript-App-Design-Flow/blob/main/AGENTS.md) → [`flows/README.md`](https://github.com/OctoSense-org/OctoScript-App-Design-Flow/blob/main/flows/README.md) → [`docs/QUICKSTART.md`](https://github.com/OctoSense-org/OctoScript-App-Design-Flow/blob/main/docs/QUICKSTART.md). + Reusable native HTML/CSS rendering for Makepad applications. The standalone Rust core lays out and paints documents; the optional `HtmlView` widget displays them with native scrolling. Applications supply HTML, resource bytes, viewport size and lifecycle decisions. This repository owns the rendering API, Makepad adapter, standalone viewer, Blitz patches and compatibility lab. Robrix’s article editor is one consumer. [Architecture and responsibilities](docs/architecture.md). diff --git a/README.zh-CN.md b/README.zh-CN.md index 9443bc8..6a6fa34 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -2,6 +2,8 @@ [English](README.md) | 简体中文 +> **要开发 OctoSense 应用?** 你不需要这个仓库:它是供 Makepad 应用使用的 Rust 库(Robrix 在用)。脚本应用显示富文本请使用 [SCRIPT-API](https://github.com/OctoSense-org/OctoScript-App-Design-Flow/blob/main/docs/SCRIPT-API.md#widgets-available-to-an-app) 列出的 `Html` 和 `Markdown` 控件。请按 [OctoSense 组织主页](https://github.com/OctoSense-org)给出的顺序阅读:[OctoScript-App-Design-Flow `AGENTS.md`](https://github.com/OctoSense-org/OctoScript-App-Design-Flow/blob/main/AGENTS.md) → [`flows/README.md`](https://github.com/OctoSense-org/OctoScript-App-Design-Flow/blob/main/flows/README.md) → [`docs/QUICKSTART.md`](https://github.com/OctoSense-org/OctoScript-App-Design-Flow/blob/main/docs/QUICKSTART.md)。 + 为 Makepad 应用提供可复用的原生 HTML/CSS 渲染。独立的 Rust 核心负责文档的布局与绘制;可选的 `HtmlView` 控件以原生滚动方式显示渲染结果。应用负责提供 HTML、资源字节、视口尺寸以及生命周期决策。 本仓库负责渲染 API、Makepad 适配层、独立查看器、Blitz 补丁和兼容性实验室。Robrix 的文章编辑器是其中一个使用方。参见[架构与职责](docs/architecture.md)。