search

rsm-hcd / AndcultureCode.Cli

and-cli command-line tool to manage the development of software applications
https://andculture.com
Apache License 2.0
14 stars 15 forks source link

Documentation related tooling #11

Open wintondeshong opened 4 years ago

wintondeshong commented 4 years ago

Devise strategy for documentation related tooling

KevinBusch commented 4 years ago

@wintondeshong have you had any or heard any thoughts on an approach for technical / pattern documentation? Wondering if we should take a similar approach to what we did with Edio where each folder could have a README.md file which is automatically linked to the root README.md doc essentially creating a table of contents.

KevinBusch commented 4 years ago

My thoughts are that if we take this approach, it would probably make sense to have a source markdown file which is used for devs to actually document. The process could then read that content via a file pattern and then copy that content to a README.md file within the same folder and apply links between it, sub README.md files, the root README.md file, and possibly the next README.md file above it in the path. In Edio, it automatically reads and updates a single README.md file which is no bueno and has caused issues.