Public docs UI — browse + read
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 新手友好度
- 55/100
- Issue 类型
- 功能
- 描述清晰度
- 描述清楚
- 活跃度
- 活跃
- 技术栈
- react, typescript
调研方向
Start by resolving the #446 blocker and reading the docs plugin's public mount and route composition conventions. Implement the _public/docs/ index and _public/docs/$slug/ read route, using the shared MarkdownRenderer; keep manifest.gen.json and routeConfig.gen.ts generated-only. Done when docs appear with tags and sidebar navigation, a real doc renders with code highlighting in the app shell, and typecheck, lint, and the path-collision guard pass.
由索引模型根据 Issue 内容生成。
描述
Parent
#444
What to build
The docs plugin's UI surface under the public mount: a browsable index and a read route that render the repository's docs in the app shell, gate-free. Content changes flow from repo merges → deploy → recompiled content — no runtime state.
_public/docs/index (list with tags;staticData.naventry so it appears in the composed sidebar) and_public/docs/$slug/read route- One shared
MarkdownRenderer(react-markdown + shiki for code highlighting) — the same component any future draft-editor preview will reuse, giving preview parity by construction - Route/manifest generation (
manifest.gen.json,routeConfig.gen.ts) stays generated-only;data-testidselectors follow the browser-regression conventions
Blocked by: #446
Acceptance criteria
-
/docslists the repository's docs with tags; the sidebar shows the nav entry -
/docs/<slug>renders a real doc's markdown with code highlighting, inside the app shell - Routes mount under the
publicmount (no gate); compose path-collision guard stays green -
pnpm run typecheckandpnpm run lintpass
- 主要语言
- TypeScript
- 星标
- 5
- 派生
- 3
- 平均合并
- 9 小时 58 分钟
- 30 天内合并 PR
- 212
环境准备
- 提供 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
NEARBuilders/everything-dev 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 72/100
NEARBuilders/everything-dev#696 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 66/100
NEARBuilders/everything-dev#686 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 82/100
NEARBuilders/everything-dev#678 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 77/100
NEARBuilders/everything-dev#628 · 1 条评论 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 78/100
NEARBuilders/everything-dev#400 ·
维护者通常 1 天内回复
查看 NEARBuilders/everything-dev 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 78/100
paperclipai/paperclip#19120 ·
维护者通常 1 天内回复
-
Gradle liquibaseDiffChangelog drops jhi_date_time_wrapper可能已有人在做 @mraible 今天认领。 未关闭area: triage theme: undefined
难度 2/5 1-3 小时 新手友好度 88/100
jhipster/generator-jhipster#35998 ·
维护者通常 1 天内回复
-
ai:assign:coding feature p3 ui-ux windows
难度 1/5 1 小时以内 新手友好度 82/100
CherryHQ/cherry-studio#23569 · 2 条评论 · 1 个 reaction ·
维护者通常 1 天内回复
-
community first-timers-only good first issue hacktoberfest help wanted low hanging fruit up-for-grabs
难度 1/5 1 小时以内 新手友好度 78/100
lingdojo/kana-dojo#33602 · 1 条评论 · 5 个 reaction ·
维护者通常 1 天内回复
-
bug
难度 2/5 1-3 小时 新手友好度 78/100
GoogleCloudPlatform/BigQuery-Agent-Analytics-Plugins#16 ·
维护者通常 1 天内回复