angular-ui/ui-grid

Better Documentation Style Request

Open

#6,010 opened on Feb 14, 2017

View on GitHub
 (0 comments) (1 reaction) (0 assignees)JavaScript (5,395 stars) (2,496 forks)batch import
good first issuetype: docs

Description

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

Contributor guide

Tech stack
javascript
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
familiarity with ui grid documentation systembasic understanding of HTML/CSS
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
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.