From a125839267c5a91342a6e0205f769aa1a9ccf9c2 Mon Sep 17 00:00:00 2001
From: Bryan Braun <bbraun7@gmail.com>
Date: Mon, 1 Apr 2024 10:55:52 -0400
Subject: [PATCH] :memo: update docs site (broken link) and README

---
 README.md                          | 8 +++++++-
 docs/{anchor.js => docs-anchor.js} | 0
 docs/index.html                    | 4 ++--
 package.json                       | 4 ++--
 4 files changed, 11 insertions(+), 5 deletions(-)
 rename docs/{anchor.js => docs-anchor.js} (100%)

diff --git a/README.md b/README.md
index 048d11d..f8a4310 100644
--- a/README.md
+++ b/README.md
@@ -53,7 +53,7 @@ Currently Supports: IE9+ and modern browsers
 To contribute:
 
 1. Fork/Clone the repo.
-2. Make your changes.
+2. Make your changes (the main source file is `anchor.js`).
 3. Write tests as needed.
 4. Run tests locally to confirm everything is working:
    - Install test modules: Run `npm ci`
@@ -61,6 +61,12 @@ To contribute:
 5. Minify and prepare the code: `npm run build`
 6. Submit a Pull Request.
 
+### Docs
+
+The docs site (in `/docs`) is a good place to test changes visually, because it has a lot of AnchorJS examples. The site can be viewed locally by opening `/docs/index.html` in a web browser. The docs are written in plain HTML and can be edited directly.
+
+The version of AnchorJS used in the docs (`docs-anchor.js`) is a copy of the true source file (`anchor.js`), and is unminified (for easy testing, editing, and debugging). You don't need to include changes to `docs-anchor.js` in your PR. `docs-anchor.js` is overwritten to the latest version of AnchorJS source as part of `npm run build` (which is run when publishing a new version of anchor-js).
+
 ## License
 
 Licensed with the [MIT License](/LICENSE).
diff --git a/docs/anchor.js b/docs/docs-anchor.js
similarity index 100%
rename from docs/anchor.js
rename to docs/docs-anchor.js
diff --git a/docs/index.html b/docs/index.html
index 5d3d8c0..a2c71bb 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -331,7 +331,7 @@ <h3 data-anchor-id="section-ids">Section IDs</h3>
 &lt;script&gt;
   anchors.add('h3');
 &lt;/script&gt;</code></pre>
-      <p>This allows you to do things like <a href="https://css-tricks.com/on-target/#article-header-id-3">highlight sections when your users jump to them</a>.</p>
+      <p>This allows you to do things like <a href="https://css-tricks.com/css-target/#aa-a-perfect-use-highlighting-sections">highlight sections when your users jump to them</a>.</p>
     </section>
 
     <h3>Multiple sets of anchors</h3>
@@ -811,7 +811,7 @@ <h3>Tooltip</h3>
     </div>
     <footer class="footer"><p><small>Made by <a href="https://www.bryanbraun.com/">Bryan</a>. You should <a href="https://twitter.com/intent/tweet?text=Hi%20%40BryanEBraun%2C%20">say hi</a> sometime. 👋</small></p></footer>
   </section>
-  <script src="anchor.js"></script>
+  <script src="docs-anchor.js"></script>
   <script src="scripts.js"></script>
   <script>
     anchors.add('.main > h2, .main > h3, .main > section > h2, .main > section > h3').remove('.used-by-label');
diff --git a/package.json b/package.json
index 36349f0..e914435 100644
--- a/package.json
+++ b/package.json
@@ -24,11 +24,11 @@
   ],
   "scripts": {
     "add-banner": "node banner.js",
-    "copy-dist": "shx cp anchor.js docs/anchor.js",
+    "copy-to-docs": "shx cp anchor.js docs/docs-anchor.js",
     "jasmine": "karma start test/karma.conf.js --single-run",
     "lint": "eslint .",
     "lockfile-lint": "lockfile-lint --allowed-hosts npm --validate-https --type npm --path package-lock.json",
-    "build": "npm-run-all uglify add-banner copy-dist",
+    "build": "npm-run-all uglify add-banner copy-to-docs",
     "uglify": "uglifyjs anchor.js --compress passes=2 --mangle --comments \"/Copyright/\" -o anchor.min.js",
     "test": "npm-run-all --continue-on-error --aggregate-output --parallel lint lockfile-lint jasmine"
   },