Giters

adrianvlupu / C4-Builder

This is a documentation builder. You feed it .md and .puml and it exports a site, pdf, or a markdown with navigation.

Home Page:https://adrianvlupu.github.io/C4-Builder/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Use top-level README file

kevinbader opened this issue · comments

commented

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.