While working on the documentation for the DNS, I am realizing that keeping the snippets, module-specific readme, and main readme consistent is quite difficult and time consuming. I wonder if for the future use, we could benefit from a script which would generate the main readme from the module specific ones. The main readme would look somewhat as follows:
Doing Magic
==========
{include magic-module:first-part}
{include magic-module:second-part}
The module specific one:
...
{block magic-module:first-part}
This is the first part...
{/block}
...
{block magic-module:second-part}
This is the second part...
{/block}
...
The script would simply do replacements making the main readme this:
Doing Magic
==========
This is the first part...
This is the second part...
and it would also erase annotations from the second module-specific readme.
While working on the documentation for the DNS, I am realizing that keeping the snippets, module-specific readme, and main readme consistent is quite difficult and time consuming. I wonder if for the future use, we could benefit from a script which would generate the main readme from the module specific ones. The main readme would look somewhat as follows:
The module specific one:
The script would simply do replacements making the main readme this:
and it would also erase annotations from the second module-specific readme.