-
Notifications
You must be signed in to change notification settings - Fork 875
update dgeni templates and site CSS for new API design #964
Comments
List of tasks & priorities for API Doc:
Main content
|
Please note that we do not yet have hooks for the Stable / Draft / Deprecated indicator output by dgeni, and I think we still need to figure out how to make "Improve This Doc" work. @IgorMinar @petebacondarwin. |
To accomplish this work the template file located in |
Additional fields in the documentation are needed to [achieve the proposal](url Consider the following Angular 2 directive. There currently doesn't exist a predictable way of delimiting sections in the doc string. @petebacondarwin has discussed with me the possible intent of adding |
Updating with status for others. I ran this past @mhevery -- One concern is that we'll need to update the Dart transformers to correctly output this for the Dart version of the API docs. Could you keep a list of the new annotations that you add so it's easy for me to get them all in one update later? |
@naomiblack I've made a list here #1028, I will be submitting a separate PR which adds support for these tags. |
Indeed |
We worked with a designer to come up with improved styling for the API doc pages. Implementing this has two parts:
The designer we worked with didn't have Angular expertise, so came up with a WIP PR (#585) where she applied the style changes to the output final pages to show what it should look like. The WIP is just for illustration; the work was done on the generated output files, not the source that is used to create them.
See attached PDF for the full design:
APIDoc_design-proposal.pdf
The text was updated successfully, but these errors were encountered: