race2infinity/The-Documentation-Compendium

Minimal template has link to missing "Deployment" section

Addono opened this issue · 0 comments

The minimal README.md template has a link to "Deployment" in the intro of "Getting Started". However, this section is by default not present in the template.

To me, it seems that there are two ways to address this:

  1. Rewrite the sentence in "Getting Started" and instead refer to "Usage" of the project rather than "Deployment".
  2. Add the "Deployment" section, similarly as it is present in the standard README version.

My take would be to go for (1), as it is probably more in line with the minimalistic nature of this template. However, (2) might be easier, as it requires just copy-pasting from the standard template. Another advantage of (2) would be that minimal and standard deviate as little as possible from each other, making migration between the two easier.