Skip to content
This repository was archived by the owner on Mar 31, 2025. It is now read-only.

Commit 6f7b0fc

Browse files
shairezpetebacondarwin
authored andcommitted
fix(ngdoc/templates): move module installation above description
When learning about an Angular module, it is not obvious sometimes that a module is external from looking at the docs and trying to learn about it. Example: ngMessages. If you never used it before, you might think it comes with Angular and waste time on debugging why it is not working. Like on any github readme.md file, I think it might be better to start the doc with the installation requirements to indicate this is an external module you need to bower/npm install Closes #134
1 parent 3311c61 commit 6f7b0fc

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

ngdoc/templates/api/module.template.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@ <h1>
55
{% if doc.title %}{$ doc.title | marked $}{% else %}{$ doc.name | code $}{% endif %}
66
</h1>
77

8-
{$ doc.description | marked $}
9-
108
{% if doc.name != 'ng' and doc.name != 'auto' %}
119
<h2>Installation</h2>
1210

@@ -41,6 +39,8 @@ <h2>Installation</h2>
4139
<p>With that you&apos;re ready to get started!</p>
4240
{% endif %}
4341

42+
{$ doc.description | marked $}
43+
4444
<div class="component-breakdown">
4545
<h2>Module Components</h2>
4646
{% for componentGroup in doc.componentGroups %}
@@ -67,4 +67,4 @@ <h2>Usage</h2>
6767
{$ doc.usage | marked $}
6868
{% endif %}
6969

70-
{% endblock %}
70+
{% endblock %}

0 commit comments

Comments
 (0)