docs: doc internal links are now working

[ocombe]

Links from docs to docs are now working. For example:

This directive is deprecated. Prefer using the $timeline service. This directive is used to animate an element in conjunction with an animate directive

animate is now a correct link to the directive animate (inside the docs).
To make sure internal links work, you need to comment internal docs like this:

This directive is deprecated. Prefer using the $timeline service. This element is used to specify the animation of an element in a {@link api/directive/faAnimation faAnimation} directive

Should be:

This directive is deprecated. Prefer using the $timeline service. This element is used to specify the animation of an element in a {@link faAnimation faAnimation} directive

Don't use the full link for internal doc, the parser will make it for you.

[zackbrown]

Good to know, and thanks for fixing. We can push out the updates to the live docs site along with the next tagged release.

[zackbrown]

hmmmm actually, this PR corrupts my local git repo. Maybe it's related to having amended + push -fed to the docs repo? Or can you think of anything else that this could be?

For example

> git status
On branch ocombe-fix-docs-links
nothing to commit, working directory clean

> git checkout master
fatal: unable to read tree 93b785428d54d60db8fa8fdee292cbd23e07dc31

And the output of git fsck

> git fsck
Checking object directories: 100% (256/256), done.
Checking objects: 100% (7605/7605), done.
error: 93b785428d54d60db8fa8fdee292cbd23e07dc31: invalid sha1 pointer in cache-tree
broken link from    tree 9a1dbb1f7d4961154fc1553f0579a676707e72b6
              to    tree 93b785428d54d60db8fa8fdee292cbd23e07dc31
missing blob 6cf18967b5f5c8a602bbc8aa4569e485dd2714f7
missing tree 93b785428d54d60db8fa8fdee292cbd23e07dc31

[ocombe]

Hmm that's possible. You can probably reset the pointer to the last commit
on the docs repository ?