Add tool-specific documentation to the source code

Question

Add tool-specific documentation to the source code

Opened this issue 2 years ago · 3 comments

This could simply be done by adding README.md files to the relevant subfolders of the long repo, just to help developers looking at the source code for the first time.

Answer 1 · 2023-04-19T09:55:45.000Z

Additionally, there could be a general README.md in the long project root folder summarizing all the different tools that are used.

Answer 2 · 2023-04-19T15:14:09.000Z

Something else that should be documented: must install hadolint locally in order to successfully run pre-commit hook.

Answer 3 · 2023-04-19T16:31:27.000Z

Because the docs are written using docsify in the docs/ directory, it is better to keep following this structure. Currently writing tool-specific documentation in docs/infrastructure.md.