Dynamic responsive masthead menu from documentation manifests
维护者通常 1 天内回复
评估
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 新手友好度
- 48/100
- Issue 类型
- 功能
- 描述清晰度
- 基本清楚
- 活跃度
- 活跃
- 技术栈
- javascript
调研方向
Start by reading the current masthead and tracing the normalized manifest data produced during package ingestion, including the packaged kb-docs.json metadata. Then inspect existing catalog and packaged-document navigation behavior before adding tests for manifest-driven entries, compact responsive behavior, current-page state, and keyboard access. Done means all published manifest pages remain reachable without overflow and the existing navigation paths still work.
由索引模型根据 Issue 内容生成。
描述
Feature Description
Replace current masthead’s fixed Library and current-app breadcrumb-style links with dynamic navigation built from packaged kb-docs.json manifests.
Menu must expose documentation apps and their published HTML pages, allowing package owners to add documentation pages through their manifest without masthead source changes.
Problem / Opportunity
Current masthead only identifies library and active app. Users cannot navigate directly among available documentation sites or pages. Fixed horizontal links also risk overflow on tablet and smaller displays.
Acceptance Criteria
- Masthead navigation derives app and page entries from loaded
kb-docs.jsonmanifests, including manifest-defined page titles, paths, ordering, and sections. - Any valid HTML documentation page published in package manifest can appear as clickable navigation item without knowledge-base code changes.
- Navigation remains usable at every viewport width.
- Tablet-first responsive behavior prevents horizontal overflow:
- compact clickable menu control shown when links cannot fit;
- menu exposes all navigation entries;
- links wrap or collapse predictably without clipping, overlap, or off-screen content.
- Menu supports keyboard navigation, visible focus, accessible names, and correct current-page state.
- Existing catalog and packaged-document navigation paths remain valid.
- Automated tests cover manifest-driven menu generation, overflow/compact menu behavior, current-page state, and keyboard-accessible controls.
Proposed Solution
Build masthead navigation from normalized manifest data already used during package ingestion. Render full navigation when space allows; use accessible collapsible/disclosure menu at tablet-sized and narrower layouts, or when measured links overflow.
Keep catalog entry available and preserve absolute knowledge-base URL behavior.
Dependencies / Related
None.
Additional Context
Current artifact contract already supports per-app page metadata: titles, paths, ordering, and optional sections. Existing masthead currently renders library plus active-app context only.
- 主要语言
- JavaScript
- 星标
- 0
- 派生
- 0
- 平均合并
- 20 分钟
- 30 天内合并 PR
- 8
环境准备
- 提供 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
AbsaOSS/knowledge-base 的其他 Issue
-
enhancement
难度 5/5 一周以上 新手友好度 30/100
AbsaOSS/knowledge-base#118 ·
维护者通常 1 天内回复
-
feat: expose knowledge-base documentation through an MCP server可能已有人在做 @oto-macenauer-absa 于 16 天前认领。 未关闭enhancement
难度 5/5 一周以上 新手友好度 35/100
AbsaOSS/knowledge-base#117 · 已指派 1 人 ·
维护者通常 1 天内回复
-
enhancement
难度 4/5 3-5 天 新手友好度 52/100
AbsaOSS/knowledge-base#114 · 1 个 reaction ·
维护者通常 1 天内回复
-
难度 5/5 一周以上 新手友好度 35/100
AbsaOSS/knowledge-base#113 ·
维护者通常 1 天内回复
查看 AbsaOSS/knowledge-base 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 84/100
andromarces/agent-loops#976 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 84/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 65/100
openstreetmap/iD#13019 ·
维护者通常 2 天内回复
-
bug main ui
难度 2/5 1-3 小时 新手友好度 65/100
openhab/openhab-webui#4600 ·
维护者通常 4 天内回复
-
bug
难度 2/5 1-3 小时 新手友好度 85/100
维护者通常 1 天内回复