Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature: Add 'readme' command. #121

Open
doosuu opened this issue Jul 4, 2023 · 0 comments
Open

Feature: Add 'readme' command. #121

doosuu opened this issue Jul 4, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@doosuu
Copy link
Member

doosuu commented Jul 4, 2023

The CLI is missing a readme command which iterates over all packages and merges their README.md files into one big readme which summarizes the capabilities of the template repository.

The idea is to output a docs folder which contains all documentation from all used packages with one entry point markdown file which links all of these READMEs together:

Folder structure might look like this:

<root>/
├── doc/
│   └── index.md
│   └── devenv-runtimes/
│       └── index.md
│   └── devenv-github-integration/
│       └── index.md

Main index.md may look like this:

# SampleApp

## The project consists of the following packages

* devenv-runtimes (link-to-respective-index-md)
  * <list-of-exposed-programs>
  * <list-of-exposed-variables>
* devenv-github-integration (link-to-respective-index-md)
  * <list-of-exposed-programs>
  * <list-of-exposed-variables>
@doosuu doosuu added enhancement New feature or request documentation Improvements or additions to documentation labels Jul 4, 2023
@dennismeister93 dennismeister93 moved this from 🆕 New to 📋 Backlog in Velocitas Backlog Jul 19, 2023
@dennismeister93 dennismeister93 moved this from 🆕 New to 📋 Backlog in Velocitas Backlog Aug 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
Status: 📋 Backlog
Development

No branches or pull requests

1 participant