angular-ui/ui-grid

Better Documentation Style Request

Open

#6,010 创建于 2017年2月14日

在 GitHub 查看
 (0 评论) (1 反应) (0 负责人)JavaScript (5,395 star) (2,496 fork)batch import
good first issuetype: docs

描述

I think the style of the documentation is difficult to get the main idea of the grid and also hard to find and read the things. I am not sure if it is feasible or not but I recommend to you (documentation contributors) check ExtJs documentation; http://docs.sencha.com/extjs/6.2.1/modern/Ext.html

You can see the "configs", "properties", "methods" and "events" from the head of the page by some kind of popover menu: http://docs.sencha.com/extjs/6.2.1/classic/Ext.view.Table.html

贡献者指南

技术栈
javascript
领域
documentation
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
half day
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
mostly clear
前置要求
familiarity with ui grid documentation systembasic understanding of HTML/CSS
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
40
研究方向
Examine the current documentation generation system for ui grid, likely in the repository's documentation folder. Investigate how the ExtJs documentation implements popover menus for configs, properties, methods, and events. Propose modifications to the ui grid documentation template or explore using a different documentation generator that supports similar navigation. Evaluate the effort and feasibility of implementing such a change.