I think the title pretty much sums up this post!

For the about sections of the pods listed in the FantomFactory site I thought it'd be nice if the content could be taken from a /doc/about.fandoc file in the pod.

Only when this file exists, neither the Status302 repo nor the fandoc viewer flux extension recognises the existing pod.fandoc file, meaning the pod looses its documentation! Argh!

I think it maybe to do with compilerDoc::DocPod which sets the podDoc in finishChapters() with these lines:

378:  if (list.size == 1 && list.first.isPodDoc)
379:    this.podDoc = list.first

which suggests there should only be the one .fandoc file.

Having looked at the code, I know a pod can only be either a documentation pod or a code pod, but what are / should be the rules surrounding having a pod.fandoc?

Having looked at the code, I know a pod can only be either a documentation pod or a code pod, but what are / should be the rules surrounding having a pod.fandoc?

As you said a pod is either a documentation or a code pod. If its a documentation pod then it has one or more chapters and a index.fog file. A code pod has exactly zero or one pod.fandoc files in the pod root directory of the source tree (during compilation it goes into the doc/ subdirectory of the zip file).

Cool, but can (should?) a code pod have more than one .fandoc file in the doc/ subdirectory?

Asking because I'd like my code pods to have both a pod.fandoc and an about.fandoc file in doc/.

Right now all the documentation is designed to process only one fandoc file (which goes in the index below the class listing)

That's cool - I'm not asking for any changes to how the documentation or code pods are displayed. I'd just like to put other files in the doc/ dir with the extension .fandoc for my own personal use.

The issue is, as soon as I do that, the existing pod.fandoc is no longer recognised.

My workaround for now is to rename these files to have a .fdoc extension. But, for fantom consistency, I'd rather that all fandoc files have the .fandoc extension.

Then we just need some other unambiguous way to distinguish the difference between a code pod vs doc pod - I'd have to poke around to see good way to do that

You also just put in another location in the pod via resDis, and sidestep that issue.

@Brain - cool, that's what I was asking for.

@Andy - true. But as they are documentation files, I'd really like them to live in the /doc dir.

Oh, and renaming the files in question also side stepped the issue! :)