Add Option to Include README.md for Module-Specific Notes

[Kibukx]

Hello @virgofx, first of all very nice project!

I have a suggestion: it would be great if we could add a README.md to each module for additional notes and considerations that users should be aware of and add them as another section to the automated wiki pages it creates. This would be helpful because it would eliminate the need to maintain separate documentation for these types of side notes.

[virgofx]

Hi @Kibukx - Thanks for the kind words.

This is a great idea. I've wanted to make the Wiki more customizable. I'm going to think about the best way to implement this so I can get this right. Here are a few more thoughts swirling in my head as I'm thinking best on tackling this.

• Should any of the customizable heading sections that are injected also be displayed in the table of contents on the right?

• In order to keep proper H# levels, should we parse the readme and any H1s or HXs that are greater than the matching section, downgrade

• Ingest the whole README.md before the terraform docs portion?

• Customizability?

• Should we have hidden delimiters to mark which content should be included

[Kibukx]

Hi @virgofx, thanks for considering this idea! I appreciate the thought you're putting into making the Wiki more customizable. Here are my thoughts on the points you raised:

1. Table of Contents (TOC): It would be great to have at least an "Additional Notes" or "Relevant Information" section in the TOC to make user-added notes easy to find.

2. Heading Levels: Yes, the headings should be adjusted to fit the structure of the generated Wiki to maintain consistency.

3. Placement: I think placing the additional/module notes after the Terraform docs would be best since they are supplemental to the primary documentation.

4 & 5. Customizability & Delimiters: I think giving users the option to include only specific parts of the README.md in the Wiki would work well. This would prevent the Wiki from becoming too large. Alternatively, for simplicity, instead of embedding the content directly, the Wiki could just provide a hyperlink to the module’s README.md file.
Let me know what you think! Happy to discuss further if needed.