[FEATURE] Documentation extraction from package

[nandagopalan]

Create a script that extracts package readme from https://github.com/nandlabs/golly. This needs to happen for every release.

We also need to maintain the golly docs link for old releases.

[nandagopalan]

@neo7337 am thinking that we need to have a place holder in package to indicate that the readme of this package can be extracted to create documentation. Something like empty file named .use-doc

any suggestions ?

[neo7337]

Each package would contain a README.md file, we can traverse and parse the documentation based on that and we will also know which documentation belongs to which package. Won't this work?🤔 @nandagopalan

[nandagopalan]

Well some packages you may want to have the Readme.md for technical information but don't want it to be documented isn't it?

The proposal is to have a file/marker to indicate that this README should go as doco website

[neo7337]

I guess for that purpose we can create a marker file.