Support federation of non-API docs with YUIdoc output

[633squadron]

If I use the JSDoc3 tool, I can link from tutorials written in HTML to the API docs, because JSDoc3 allows {@link} tags in .html files. JSDoc3 resolves {@link} tags across any file it processes, and it processes files in a special "tutorials" directory even if the files don't have the standard JavaScript with comments format.

I would like to have the same functionality in YUIdoc. Having this functionality would allow me to create an integrated set of documentation that contains a concepts guide, a developers guide, a set of tutorials, and a reference guide. An integrated documentation set is much easier to implement and manage than a set of documents that are generated with different tools.

As part of an integrated documentation set functionality, YUIdoc should have the ability to generate a table of contents across all the different types of documents.

[okuryu]

Thanks for your suggestion! I'd like to investigation for this.

[andyearnshaw]

I'd like to take a stab at this next, if that's ok?

[633squadron]

Sure! I'm no longer working with yuidoc, since I was laid off from the
company that needed it. I'm also recovering from a severe illness.

And even so, I'll do my darndest to help in any way I can. You might want
to look at the specs for doclava. It was written at Google, but it's now
OSS. It's mostly an improvement for the standard Java doclet, but it also
supports federation.

On Thu, Jul 30, 2015 at 3:15 PM, Andy Earnshaw notifications@github.com
wrote:

I'd like to take a stab at this next, if that's ok?

—
Reply to this email directly or view it on GitHub
#299 (comment).

[okuryu]

@andrewnicols Sure, I definitely welcome your contributions.