Overhaul deployer documentation

joshuaauerbachwatson commented 3 years ago

The parts of the documentation set that deal primarily with the deployer (nim project deploy) were originally a single document but are now broken into many documents. You can roughly divide these pieces into less formal "how to" documents and more formal "reference" documents. It has been while since this breakup occurred and during that time those parts of the documentation have not kept up with code changes. The plan is

[ ] Largely rewrite the reference parts, centered on a new "specification" document.
[ ] Tweak the less formal documents and work a little on the attachment of these documents to the TOC so that nothing in the older documents is actually incorrect or misleading

Work on this began prior to opening this issue and is on branch add-spec. I will make a draft PR for that branch to make it easier to follow the work.

joshuaauerbachwatson commented 3 years ago

Progress on this issue will be tracked primarily in the associated PR #55.

joshuaauerbachwatson commented 3 years ago

I think I actually did enough work on this to consider it closed. Specific shortcomings can be addressed in more focused issues.

nimbella / docs

Overhaul deployer documentation #54