JavaScript Scaffolder API

[travi]

Since we've been talking a bit about improving these docs, I wanted to bring the conversation out here so that we can track it a little better. I'll capture some high-level thoughts that I've mentioned. Obviously, feel free to capture more.

Structure

I think we've outgrown the README.md as the place for these docs. I'd like to see us start by moving the docs to separate file(s) in docs/ and linking to docs/index.md from the root readme. We could then configure the repo to push them out to GitHub Pages and put a domain on it, like javascript-scaffolder.form8ion.dev. I did similar with https://github.com/travi/any (https://travi.github.io/any/)

I think the index.md can be the place for the intro description, but mainly a launch pad for other sections from there.

Potential Sections

• Glossary
• Context options (root project vs sub-project)
• Core inputs
• CI Scaffolders (what the js-scaffolder passes to them and what is expected to be returned)
• App Scaffolders (what the js-scaffolder passes to them and what is expected to be returned)
• Package Scaffolders (what the js-scaffolder passes to them and what is expected to be returned)

What big things am I missing?