feat: rewrite docs generation

High level overview of the changes here:

- The source for the docs content has moved from `docs/content/` to
  `docs/lib/content/`. The generated markdown is still written to
  `docs/content/` but that directory is now ignored from git.
- All generated content sections of the docs have been removed and
  replaced with single placeholder html comments such as `<!--
  AUTOGENERATED CONFIG DESCRIPTIONS -->`
- Placeholders are replaced with generated content only as part of the
  `prepack` step, so generated markdown is no longer checked in to
  source and all docs related `make` commands have been removed
- All docs (and docs related) snapshots have been moved to a single test
  file that outputs command usage and formats it with functions imported
  from `docs/lib/index.js`. So tests will fail if docs content changes
  until `npm run snap` is run.

Author: lukekarrys

.github/workflows/ci-docs.yml .github/workflows/ci-npmcli-docs.yml

@@ -1,6 +1,6 @@
 # This file is automatically added by @npmcli/template-oss. Do not edit.
 
-name: CI - docs
+name: CI - @npmcli/docs
 
 on:
   workflow_dispatch:
@@ -71,9 +71,9 @@ jobs:
       - name: Reset Deps
         run: node . run resetdeps
       - name: Lint
-        run: node . run lint --ignore-scripts -w docs
+        run: node . run lint --ignore-scripts -w @npmcli/docs
       - name: Post Lint
-        run: node . run postlint --ignore-scripts -w docs
+        run: node . run postlint --ignore-scripts -w @npmcli/docs
 
   test:
     name: Test - ${{ matrix.platform.name }} - ${{ matrix.node-version }}
@@ -119,7 +119,7 @@ jobs:
       - name: Add Problem Matcher
         run: echo "::add-matcher::.github/matchers/tap.json"
       - name: Test
-        run: node . test --ignore-scripts -w docs
+        run: node . test --ignore-scripts -w @npmcli/docs
       - name: Check Git Status
         if: matrix && matrix.platform.os != 'windows-latest'
         run: node scripts/git-dirty.js

.github/workflows/ci.yml

@@ -135,32 +135,6 @@ jobs:
         if: matrix && matrix.platform.os != 'windows-latest'
         run: node scripts/git-dirty.js
 
-  check-docs:
-    name: Check Docs
-    if: github.repository_owner == 'npm'
-    runs-on: ubuntu-latest
-    defaults:
-      run:
-        shell: bash
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-      - name: Setup Git User
-        run: |
-          git config --global user.email "npm-cli+bot@github.com"
-          git config --global user.name "npm CLI robot"
-      - name: Setup Node
-        uses: actions/setup-node@v3
-        with:
-          node-version: 18.x
-          cache: npm
-      - name: Reset Deps
-        run: node . run resetdeps
-      - name: Make Docs
-        run: make freshdocs
-      - name: Check Git Status
-        run: node scripts/git-dirty.js
-
   licenses:
     name: Check Licenses
     if: github.repository_owner == 'npm'