-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Script for updating main README #753
Copy link
Copy link
Closed
Labels
api: corepriority: p2Moderately-important priority. Fix may not be included in next release.Moderately-important priority. Fix may not be included in next release.type: questionRequest for information or clarification. Not an issue.Request for information or clarification. Not an issue.
Metadata
Metadata
Assignees
Labels
api: corepriority: p2Moderately-important priority. Fix may not be included in next release.Moderately-important priority. Fix may not be included in next release.type: questionRequest for information or clarification. Not an issue.Request for information or clarification. Not an issue.
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.