Skip to content
This repository has been archived by the owner on Sep 5, 2024. It is now read-only.

Docs: Restyle API methods, attributes and parameters into more readable format #984

Closed
marcysutton opened this issue Dec 18, 2014 · 1 comment
Closed

Docs: Restyle API methods, attributes and parameters into more readable format #984

marcysutton opened this issue Dec 18, 2014 · 1 comment
Assignees
@marcysutton
Labels
type: build type: docs type: enhancement
Milestone
0.10.0

Comments

@marcysutton
Copy link
Contributor

As part of #916, API details should be presented in a data-table format. Whether this actually uses HTML tables or divs with ARIA roles is TBD (related accessibility documentation).

The goal of this task is to make the API docs more readable by better utilizing visual space.

Existing mdBottomSheet documentation:

Existing mdBottomSheet documentation

A better visual presentation for methods, taken from UI Router:

Angular UI decode method
@ThomasBurleson ThomasBurleson mentioned this issue Dec 18, 2014
Closed
5 tasks
@marcysutton marcysutton self-assigned this Dec 19, 2014
@marcysutton marcysutton added this to the 0.8.0-rc1 milestone Dec 19, 2014
@marcysutton marcysutton changed the title Docs: Restyle API methods and parameters into data-tables Docs: Restyle API methods, attributes and parameters into data-tables Dec 19, 2014
@marcysutton
Copy link
Contributor Author

Wireframe for service methods such as Bottom Sheet:
Proposed Methods wireframe

@marcysutton marcysutton changed the title Docs: Restyle API methods, attributes and parameters into data-tables Docs: Restyle API methods, attributes and parameters into more readable format Dec 23, 2014
@marcysutton marcysutton modified the milestones: 0.9.0, 0.8.0-rc1 Feb 9, 2015
@marcysutton marcysutton modified the milestones: 0.10.0, 0.9.0 Apr 1, 2015
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@marcysutton marcysutton

Labels
type: build type: docs type: enhancement
Projects
None yet
Milestone
0.10.0
Development

No branches or pull requests
1 participant
@marcysutton