Documenting/Analyzing Packages

[c256985]

There doesn't seem to be a way to document packages in a way that will be picked up and used by the analyzer. In languages like Java and Groovy, you have a package.java or package.groovy file in a directory that provides developers with an overview of the package and shows people where the entry points are within an package.

But there doesn't seem to be a way that you can do that. I tried using README.md as a package description. Is there some other way of documenting the package?

Also, the documentation doesn't cover how you generate the toplevel page containing all of the packages within a directory. For example, if you want to provide people with a way of navigating through a collection of related packages.

Lastly, there doesn't seem to be a way to recursively generate the analysis.json files for all of the packages within a directory.

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[stale]

This issue has been automatically closed after being marked stale. If you're still facing this problem with the above solution, please comment and we'll reopen!