At work we keep a general wiki on the intranet for general stuff, but some of our sites are very complex and non-standard with our framework, so I decided to start writing documentation for those non-standard sites.
I think it would be a good idea storing the documentation in comments in the conf file that contains all the configuration information ( hostnames, passwords ), which is a source file that can't be read or accessed directly.
Some of the things I'll mention are things such as that the site uses non-standard rewrite rules and where to get them, the URLs to the specific admin, notes about where content is taken from for certain elements on the page, stuff like that.
I really am not a fan of keeping everything on the intranet, and I hate dealing with MediaWiki so that's the whole reason I just want to write stuff in comments. Oh and, I won't be writing anything like API documentation or mentioning any specific methods, just general stuff.
So would it be a good idea to store it in the conf file, or should it be its very own file?
Note: Our sites are mostly PHP and the DocumentRoot doesn't point to a public directory such as how many modern day frameworks are doing it, so I can't really store a .xml or .txt file in the "parent" directory of the DocumentRoot.