Repositories typically have a top-level README file that explains what the project is about and how to get started using it. I think it would be helpful to re-use that file when generating the documentation using c4builder:
/README.md # for website generation, use this as the start page (and assume it has a link to e.g. `doc/all-in-one.md`); for pdf, use this as the intro section
/src/context.md # this is the "architecture overview" linked to in the top-level readme
Are there already ways to achieve this or any thoughts on alternative approaches? If this sounds like a good idea I could also work on a PR for this.
Repositories typically have a top-level README file that explains what the project is about and how to get started using it. I think it would be helpful to re-use that file when generating the documentation using c4builder:
Are there already ways to achieve this or any thoughts on alternative approaches? If this sounds like a good idea I could also work on a PR for this.