cake-build / cake-build/website

Investigate auto generating parts of docs

Open
#586 5 comments 1 reaction 0 assignees View on GitHub
documentation
Dominant language
HTML
Stars
52
Forks
256
Avg merge
4h 42m
Merged PRs (30d)
8

Description

Currently the CLI usage is out of sync with the latest release i.e. experimental is there, bootstrap isn't and so on.

Got me thinking this should be able to be codegened, putting this in an issue for future discussion.

Did a quick PoC just parsing the help command output
```
Usage: Cake.exe [script] [--verbosity=value]
[--showdescription] [--dryrun] [..]

Example: Cake.exe
Example: Cake.exe build.cake --verbosity=quiet
Example: Cake.exe build.cake --showdescription

Options:
--verbosity=value Specifies the amount of information to be displayed.
(Quiet, Minimal, Normal, Verbose, Diagnostic)
--debug Performs a debug.
--showdescription Shows description about tasks.
--dryrun Performs a dry run.
--exclusive Execute a single task without any dependencies.
--bootstrap Download/install modules defined by #module directives
--version Displays version information.
--help Displays usage information.
```
result is
![image](https://user-images.githubusercontent.com/1647294/46735008-2eabbb00-cc95-11e8-9dfa-6a484e451db7.png)

Code for that is avail [here](https://github.com/cake-build/website/compare/develop...devlead:feature/codegencliusage), it's just a rough 5 minute PoC.

Ideally we should have better meta data i.e. if cake could report as xml, json etc. but wanted to test something end to end, basic idea is

* Have a main manually created document
* Where parts of the document is automatically generated

In the poc this is achieved using the WYAM include module and `^` preprocessor example:
```
`^"../../../generatedinput/cake-usage.md"
```

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.