Update docs for clarity

sanctuarycomputer · Nov 19, 2024 · 3fb3363 · 3fb3363
1 parent 5436cd6
commit 3fb3363
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -119,7 +119,7 @@ See https://www.npmjs.com/package/typedoc-plugin-markdown for details.
 
 # How to Update search indices with algolia
 
-- Create an .env file with `APPLICATION_ID` and the `API_KEY` (write access). 
+- Create an .env file with `APPLICATION_ID` and the `API_KEY` (Admin API Key w/ write access, should be kept secret). 
 If you don't have those, one for the Engineering Managers should be able to help you.
 - Edit config.json file if needed:
     - Start url from updated website

diff --git a/docusaurus.config.js b/docusaurus.config.js
@@ -27,7 +27,7 @@ module.exports = {
       additionalLanguages: ['solidity'],
     },
     algolia: {
-      apiKey: '32465e2ab6f7554ff014e64c0d92171c',
+      apiKey: '32465e2ab6f7554ff014e64c0d92171c', //  Search-Only API Key (Public & safe to commit)
       indexName: 'v3-docs',
       appId: 'S0IDD0YGLZ',
     },