Connecting to my original GAG post I am proposing a bit more structured approach to this project, addressing mostly @y-io, @enrico-padovani , @jonathan.eckman, @alexdresko as well as any others who might decide to join this Aurelia Community wide task.
Given the relatively significant interest in Aurelia CLI, combined with the nearly absolute lack of documentation and samples, I am proposing to start with Aurelia CLI project first - as it might be sufficiently complex to warrant a solid discussion on how to design it and how to implement it.
The key assumptions is people will be interested in understanding the steps taken from the code generated by the current Aurelia CLI desktop application to the fully fledged equivalent of the standard Navigation Skeleton applications. This approach to documenting Aurelia CLI is more obvious knowing that at some point in the future, the Aurelia CLI application will indeed be able to create and manage such Navigation Skeletons - and more.
To initiate the discussion I am proposing the following outline:
- CLI user guides present all “transformations” that need to be applied to the given generated “basic” code in order to create the equivalent of the related Navigation Skeleton. Since CLI supports a variety of languages, platforms, loaders and hopefully soon CI-CD solutions, this sections is subdivided as shown below:
- CLI developer guides is envisioned as lot more formal and condensed content of section 1. CLI user guides which is intended to be used by the Aurelia CLI core team lead by @jeroenvinke and @eisenbergeffect as data for subsequent Aureli CLI development work.
So, our Community Technical Writers Team will be working on the section 1 - assuming that we do not change this proposed structure in the discussions that should follow this post.