Update description fields for all samples (#994)

* Update `action` sample * Update `alarms` sample * Update `bookmarks` sample * Update `browsingData` sample * Update `contentSettings` sample * Update `cookies/cookie-clearer` sample * Update `debugger` sample * Update wasm functional sample * Update `functional/cookbook.geolocation-contentscript` sample * Update `cookbook.geolocation-offscreen` sample * Update `cookbook.geolocation-popup` sample * Update `cookbook.offscreen-clipboard-write` sample * Update `cookbook.offscreen-dom` sample * Fix browsingData description * Fix bookmarks description * Update offscreen document descriptions * Update descriptions * Update browsingData description * Update descriptions for all api samples * Update descriptions for cookbook samples * Update api-samples/browsingData/manifest.json Co-authored-by: Joe Medley <[email protected]> * Update api-samples/action/manifest.json Co-authored-by: Joe Medley <[email protected]> * Update api-samples/contextMenus/basic/manifest.json Co-authored-by: Joe Medley <[email protected]> * Update api-samples/cookies/cookie-clearer/manifest.json Co-authored-by: Joe Medley <[email protected]> * Update api-samples/debugger/manifest.json Co-authored-by: Joe Medley <[email protected]> * Update functional-samples/sample.favicon-cs/manifest.json Co-authored-by: Joe Medley <[email protected]> * Update functional-samples/cookbook.sidepanel-site-specific/manifest.json Co-authored-by: Joe Medley <[email protected]> * Update api-samples/omnibox/new-tab-search/manifest.json Co-authored-by: Joe Medley <[email protected]> * Update api-samples/devtools/inspectedWindow/manifest.json Co-authored-by: Joe Medley <[email protected]> * Update api-samples/override/blank_ntp/manifest.json Co-authored-by: Joe Medley <[email protected]> * Apply suggestions from code review Co-authored-by: Joe Medley <[email protected]> * Update wasm samples description * Update description * Update functional-samples/sample.co2meter/manifest.json Co-authored-by: Joe Medley <[email protected]> * Apply suggestions from code review --------- Co-authored-by: Joe Medley <[email protected]> Co-authored-by: Oliver Dunk <[email protected]>
GoogleChrome · Aug 17, 2023 · 45bbd8d · 45bbd8d
1 parent b6a3ac5
commit 45bbd8d
Show file tree

Hide file tree

Showing 51 changed files with 57 additions and 46 deletions.
diff --git a/api-samples/action/manifest.json b/api-samples/action/manifest.json
@@ -1,6 +1,7 @@
 {
   "name": "Action API Demo",
   "version": "1.0",
+  "description": "Uses the Action API to change the badge text, icon, hover text, or popup page.",
   "manifest_version": 3,
   "background": {
     "service_worker": "background.js"

diff --git a/api-samples/alarms/manifest.json b/api-samples/alarms/manifest.json
@@ -1,6 +1,7 @@
 {
   "name": "Alarms API Demo",
   "version": "1.0",
+  "description": "Uses the chrome.alarms API to allow the user to set alarms using an extension page.",
   "manifest_version": 3,
   "background": {
     "service_worker": "bg-wrapper.js"

diff --git a/api-samples/bookmarks/manifest.json b/api-samples/bookmarks/manifest.json
@@ -2,7 +2,7 @@
   "manifest_version": 3,
   "name": "Bookmark Viewer",
   "version": "1.0",
-  "description": "A simple Chrome extension to display bookmarks",
+  "description": "Uses the chrome.bookmarks API to search through, add, and delete bookmarks from the user's bookmark tree.",
   "action": {
     "default_popup": "popup.html",
     "default_icon": "icon.png"

diff --git a/api-samples/browsingData/manifest.json b/api-samples/browsingData/manifest.json
@@ -1,7 +1,7 @@
 {
   "name": "BrowsingData API: Basics",
   "version": "1.2",
-  "description": "An example implementation of the chrome.browsingData API",
+  "description": "Uses the chrome.browsingData API to clear the user's history without requiring the user to visit the history page.",
   "permissions": ["browsingData"],
   "action": {
     "default_icon": "icon.png",

diff --git a/api-samples/contentSettings/manifest.json b/api-samples/contentSettings/manifest.json
@@ -1,7 +1,7 @@
 {
   "name": "Content settings",
   "version": "0.3",
-  "description": "Shows the content settings for the current site.",
+  "description": "Uses chrome.contentSettings to display the settings of a given page in the extension's popup.",
   "permissions": ["contentSettings", "activeTab"],
   "action": {
     "default_icon": "contentSettings.png",

diff --git a/api-samples/contextMenus/basic/manifest.json b/api-samples/contextMenus/basic/manifest.json
@@ -1,6 +1,6 @@
 {
   "name": "Context Menus Sample",
-  "description": "Shows some of the features of the Context Menus API",
+  "description": "Uses the chrome.contextMenus API to customize the context menu.",
   "version": "0.7",
   "permissions": ["contextMenus"],
   "background": {

diff --git a/api-samples/contextMenus/global_context_search/manifest.json b/api-samples/contextMenus/global_context_search/manifest.json
@@ -1,6 +1,6 @@
 {
   "name": "Global Google Search",
-  "description": "Use the context menu to search a different country's Google",
+  "description": "Uses the context menu to search a different country's Google",
   "version": "1.1",
   "manifest_version": 3,
   "permissions": ["contextMenus", "storage"],

diff --git a/api-samples/cookies/cookie-clearer/manifest.json b/api-samples/cookies/cookie-clearer/manifest.json
@@ -2,6 +2,7 @@
   "name": "Cookie Clearer",
   "manifest_version": 3,
   "version": "1.0",
+  "description": "Uses the chrome.cookies API by letting a user delete their cookies via a popup.",
   "permissions": ["cookies"],
   "host_permissions": ["<all_urls>"],
   "action": {

diff --git a/api-samples/debugger/manifest.json b/api-samples/debugger/manifest.json
@@ -1,7 +1,7 @@
 {
   "manifest_version": 3,
   "name": "Debugger Extension",
-  "description": "Demonstrates the API by attaching a debugger to a webpage and capturing network data.",
+  "description": "Uses the chrome.debugger API to capture network events on web pages.",
   "version": "1.0",
   "permissions": ["debugger", "tabs"],
   "host_permissions": ["https://www.google.com/*"],

diff --git a/api-samples/declarativeNetRequest/no-cookies/manifest.json b/api-samples/declarativeNetRequest/no-cookies/manifest.json
@@ -1,6 +1,6 @@
 {
   "name": "No Cookies",
-  "description": "Removes 'Cookie' headers.",
+  "description": "Uses the chrome.declarativeNetRequest API to remove the \"Cookie\" header from requests.",
   "version": "1.0",
   "manifest_version": 3,
   "permissions": ["declarativeNetRequest", "declarativeNetRequestFeedback"],

diff --git a/api-samples/declarativeNetRequest/url-blocker/manifest.json b/api-samples/declarativeNetRequest/url-blocker/manifest.json
@@ -2,7 +2,7 @@
   "name": "URL Blocker",
   "version": "0.1",
   "manifest_version": 3,
-  "description": "Blocks all main frame requests to example.com.",
+  "description": "Uses the chrome.declarativeNetRequest API to block requests.",
   "background": {
     "service_worker": "service_worker.js"
   },

diff --git a/api-samples/declarativeNetRequest/url-redirect/manifest.json b/api-samples/declarativeNetRequest/url-redirect/manifest.json
@@ -2,7 +2,7 @@
   "name": "URL Redirect",
   "version": "0.1",
   "manifest_version": 3,
-  "description": "Redirects MV2 documents to equivalent MV3 documents on developer.chrome.com.",
+  "description": "Uses the chrome.declarativeNetRequest API to redirect requests.",
   "background": {
     "service_worker": "service_worker.js"
   },

diff --git a/api-samples/default_command_override/manifest.json b/api-samples/default_command_override/manifest.json
@@ -1,6 +1,6 @@
 {
   "name": "Tab Flipper",
-  "description": "Press Ctrl+Shift+Right or Ctrl+Shift+Left (Command+Shift+Right or Command+Shift+Left on a Mac) to flip through window tabs",
+  "description": "Uses the chrome.commands API by creating a new keyboard macro for switching tabs in the browser window.",
   "version": "1.0",
   "manifest_version": 3,
   "background": {

diff --git a/api-samples/devtools/inspectedWindow/manifest.json b/api-samples/devtools/inspectedWindow/manifest.json
@@ -1,6 +1,6 @@
 {
   "name": "Devtools - inspectedWindow API sample",
-  "description": "Makes use of the devtools.inspectedWindow API to collect data and display it inside of a devtools panel.",
+  "description": "Uses devtools.inspectedWindow to collect and use data on the resouces used in a web page.",
   "version": "1.0",
   "manifest_version": 3,
   "devtools_page": "devtools.html"

diff --git a/api-samples/devtools/panels/manifest.json b/api-samples/devtools/panels/manifest.json
@@ -1,7 +1,7 @@
 {
-  "name": "Chrome Query",
+  "name": "Devtools - Chrome Query",
   "version": "1.2",
-  "description": "Extends the Developer Tools, adding a sidebar that displays the jQuery data associated with the selected DOM element.",
+  "description": "Uses the devtools API to add a sidebar that displays the jQuery data associated with the selected DOM element.",
   "devtools_page": "devtools.html",
   "manifest_version": 3
 }
diff --git a/api-samples/favicon/manifest.json b/api-samples/favicon/manifest.json
@@ -1,6 +1,7 @@
 {
   "name": "Favicon API in a popup",
   "version": "1.1",
+  "description": "Demonstrates the favicon manifest permission by displaying the favicon of a url in the extension popup.",
   "manifest_version": 3,
   "permissions": ["favicon"],
   "action": {

diff --git a/api-samples/fontSettings/fontSettings Advanced/manifest.json b/api-samples/fontSettings/fontSettings Advanced/manifest.json
@@ -2,7 +2,7 @@
   "name": "Advanced Font Settings",
   "version": "0.7",
   "manifest_version": 3,
-  "description": "Customize per-script font settings.",
+  "description": "Demonstrates the chrome.fontSettings API by allowing users to modify the style of displayed fonts on web pages.",
   "options_page": "options.html",
   "icons": {
     "16": "fonts16.png",

diff --git a/api-samples/fontSettings/fontSettings Basic/manifest.json b/api-samples/fontSettings/fontSettings Basic/manifest.json
@@ -2,7 +2,7 @@
   "name": "Font Settings API Sample",
   "version": "1",
   "manifest_version": 3,
-  "description": "Customize font settings.",
+  "description": "Demonstrates the chrome.fontSettings API by allowing users to modify the size of fonts on webpages.",
   "action": {
     "default_popup": "popup.html"
   },

diff --git a/api-samples/history/historyOverride/manifest.json b/api-samples/history/historyOverride/manifest.json
@@ -1,7 +1,7 @@
 {
   "manifest_version": 3,
   "name": "History Override",
-  "description": "Overrides the History Page",
+  "description": "Demonstrates how to override the default history page.",
   "version": "1.0",
   "chrome_url_overrides": {
     "history": "history.html"

diff --git a/api-samples/history/showHistory/manifest.json b/api-samples/history/showHistory/manifest.json
@@ -1,7 +1,7 @@
 {
   "name": "Typed URL History",
   "version": "1.3",
-  "description": "Reads your history and uses the transition type of each history item to filter out a list of the top ten pages you go to specifically by typing the URL.",
+  "description": "Uses the chrome.history API to display in a popup the user's most visited pages.",
   "permissions": ["history"],
   "action": {
     "default_popup": "typed-urls.html",

diff --git a/api-samples/il8n/manifest.json b/api-samples/il8n/manifest.json
@@ -1,6 +1,7 @@
 {
   "manifest_version": 3,
   "name": "il8n API Example",
+  "description": "Demonstrates the chrome.i18n API by localizing text in the extension popup.",
   "version": "3",
   "action": {
     "default_popup": "popup.html"

diff --git a/api-samples/omnibox/new-tab-search/manifest.json b/api-samples/omnibox/new-tab-search/manifest.json
@@ -1,6 +1,6 @@
 {
   "name": "Omnibox - New Tab Search",
-  "description": "Type 'newTab' plus a search term into the Omnibox to open search in new tab.",
+  "description": "Demonstrates the \"omnibox\" manifest key and API by creating a keyword that opens a browser search in a new tab.",
   "version": "1.0",
   "manifest_version": 3,
   "background": {

diff --git a/api-samples/override/blank_ntp/manifest.json b/api-samples/override/blank_ntp/manifest.json
@@ -1,6 +1,6 @@
 {
   "name": "Blank new tab page",
-  "description": "Override the new tab page with a blank one",
+  "description": "Uses the \"chrome_url_overrides\" manifest key by replacing the user's default new tab page with a new html file.",
   "version": "0.3",
   "incognito": "split",
   "chrome_url_overrides": {

diff --git a/api-samples/printing/manifest.json b/api-samples/printing/manifest.json
@@ -1,7 +1,7 @@
 {
   "name": "Print Extension",
   "version": "1.0",
-  "description": "Sends print job directly to the printers installed on the Chromebook",
+  "description": "Demonstrates all four methods of the chrome.printing namespace.",
   "permissions": ["printing"],
   "action": {
     "default_popup": "printers.html",

diff --git a/api-samples/privacy/manifest.json b/api-samples/privacy/manifest.json
@@ -2,6 +2,7 @@
   "name": "Privacy API sample",
   "version": "1.0",
   "manifest_version": 3,
+  "description": "Uses the chrome.privacy.services property to get and set privacy settings.",
   "background": {
     "service_worker": "service-worker.js"
   },

diff --git a/api-samples/richNotification/manifest.json b/api-samples/richNotification/manifest.json
@@ -1,6 +1,6 @@
 {
   "name": "Notifications API sample",
-  "description": "An extension that cycles through template types of notifications whenever the user interacts with one.",
+  "description": "Demonstrates the creation of, and interaction with, each of the notification template types.",
   "version": "1.0",
   "manifest_version": 3,
   "action": {

diff --git a/api-samples/sandbox/sandbox/manifest.json b/api-samples/sandbox/sandbox/manifest.json
@@ -1,6 +1,7 @@
 {
   "name": "Sandboxed Frame Sample",
   "version": "1.0.3",
+  "description": "Demonstrates creation of a tab with a sandboxed iframe to which the main page passes a counter variable.",
   "manifest_version": 3,
   "background": {
     "service_worker": "service-worker.js"

diff --git a/api-samples/sandbox/sandboxed-content/manifest.json b/api-samples/sandbox/sandboxed-content/manifest.json
@@ -2,9 +2,10 @@
   "name": "Sandboxed Content Sample",
   "version": "1.0.3",
   "manifest_version": 3,
-    "background": {
-      "service_worker": "service-worker.js"
-    },
+  "background": {
+    "service_worker": "service-worker.js"
+  },
+  "description": "Demonstrates creating a tab for a sandboxed iframe. The sandbox calls eval() to write HTML to its own document.",
   "icons": {
     "128": "icon_128.png"
   },

diff --git a/api-samples/scripting/manifest.json b/api-samples/scripting/manifest.json
@@ -2,6 +2,7 @@
   "name": "Scripting API Demo",
   "version": "1.0",
   "manifest_version": 3,
+  "description": "Uses the chrome.scripting API to inject JavaScript into web pages.",
   "background": {
     "service_worker": "sw.js"
   },

diff --git a/api-samples/tabCapture/manifest.json b/api-samples/tabCapture/manifest.json
@@ -1,6 +1,6 @@
 {
   "name": "Tab Capture Example",
-  "description": "Capture a tab and play in a <video> element in a separate window.",
+  "description": "Demonstrates how to use the chrome.tabCapture API.",
   "version": "1",
   "manifest_version": 3,
   "action": {

diff --git a/api-samples/topSites/basic/manifest.json b/api-samples/topSites/basic/manifest.json
@@ -1,7 +1,7 @@
 {
   "name": "Top Sites",
   "version": "1.2",
-  "description": "Shows the top sites in the popup.",
+  "description": "Uses the chrome.topSites API to get the user's most visited sites.",
   "permissions": ["topSites"],
   "action": {
     "default_icon": "icon.png",

diff --git a/api-samples/topSites/magic8ball/manifest.json b/api-samples/topSites/magic8ball/manifest.json
@@ -1,7 +1,7 @@
 {
   "name": "topSites API sample",
   "version": "2",
-  "description": "An extension that demonstrates the chrome.topSites API by registering a custom new tab page.",
+  "description": "Uses the chrome.topSites API to suggest which sites a user should visit.",
   "chrome_url_overrides": {
     "newtab": "newTab.html"
   },

diff --git a/api-samples/web-accessible-resources/manifest.json b/api-samples/web-accessible-resources/manifest.json
@@ -5,6 +5,7 @@
   "background": {
     "service_worker": "service-worker.js"
   },
+  "description": "Uses the web_accessible_resources key in the manifest.json file to control access to assets within an extension.",
   "action": {},
   "content_scripts": [
     {

diff --git a/api-samples/webNavigation/basic/manifest.json b/api-samples/webNavigation/basic/manifest.json
@@ -1,7 +1,7 @@
 {
   "name": "webNavigation API Sample",
   "version": "2",
-  "description": "A demonstration of the webNavigation API",
+  "description": "Uses the webNavigation API to send notifications.",
   "background": {
     "service_worker": "service-worker.js"
   },

diff --git a/api-samples/webRequest/http-auth/manifest.json b/api-samples/webRequest/http-auth/manifest.json
@@ -2,14 +2,10 @@
   "name": "webRequest.onAuthRequired Demo",
   "version": "1.0",
   "manifest_version": 3,
+  "description": "Demonstrates the webRequest.onAuthRequired listener to detect an authentication request and log the user into the designated site.",
   "background": {
     "service_worker": "service-worker.js"
   },
-  "permissions": [
-    "webRequest",
-    "webRequestAuthProvider"
-  ],
-  "host_permissions": [
-    "https://httpbin.org/*"
-  ]
+  "permissions": ["webRequest", "webRequestAuthProvider"],
+  "host_permissions": ["https://httpbin.org/*"]
 }
diff --git a/api-samples/windows/manifest.json b/api-samples/windows/manifest.json
@@ -1,7 +1,7 @@
 {
   "name": "Merge Windows",
   "version": "1.0.3",
-  "description": "Merges all of the browser's windows into the current window",
+  "description": "Uses the chrome.windows and chrome.tabs APIs to manage tabs across different windows.",
   "icons": {
     "48": "merge_windows_48.png",
     "128": "merge_windows_128.png"

diff --git a/functional-samples/cookbook.geolocation-contentscript/manifest.json b/functional-samples/cookbook.geolocation-contentscript/manifest.json
@@ -2,6 +2,7 @@
   "name": "Geolocation - content script",
   "version": "1.0",
   "manifest_version": 3,
+  "description": "Shows how to get geolocation access within a content script.",
   "content_scripts": [
     {
       "matches": ["https://example.com/*"],

diff --git a/functional-samples/cookbook.geolocation-offscreen/manifest.json b/functional-samples/cookbook.geolocation-offscreen/manifest.json
@@ -1,6 +1,7 @@
 {
   "name": "Geolocation - offscreen",
   "version": "1.0",
+  "description": "Shows how to get geolocation access within a service worker.",
   "manifest_version": 3,
   "background": {
     "service_worker": "service_worker.js"

diff --git a/functional-samples/cookbook.geolocation-popup/manifest.json b/functional-samples/cookbook.geolocation-popup/manifest.json
@@ -1,6 +1,7 @@
 {
   "name": "Geolocation - popup",
   "version": "1.0",
+  "description": "Shows how to get geolocation access within a popup.",
   "manifest_version": 3,
   "action": {
     "default_popup": "popup.html"

diff --git a/functional-samples/cookbook.offscreen-clipboard-write/README.md b/functional-samples/cookbook.offscreen-clipboard-write/README.md
@@ -1,4 +1,4 @@
-This recipe shows how to write a string to the system clipboard using the [Offscreen API][1].
+This recipe shows how to write a string to the system clipboard using the [Offscreen document][1].
 
 ## Context
 

diff --git a/functional-samples/cookbook.offscreen-clipboard-write/manifest.json b/functional-samples/cookbook.offscreen-clipboard-write/manifest.json
@@ -2,6 +2,7 @@
   "name": "Offscreen API - Clipboard",
   "version": "1.0",
   "manifest_version": 3,
+  "description": "Shows how to write a string to the system clipboard using the offscreen document.",
   "background": {
     "service_worker": "background.js"
   },

diff --git a/functional-samples/cookbook.offscreen-dom/README.md b/functional-samples/cookbook.offscreen-dom/README.md
@@ -1,4 +1,4 @@
-This recipe shows how to use DOMParser in an Extension Service Worker using the [Offscreen API][1].
+This recipe shows how to use DOMParser in an Extension Service Worker using the [Offscreen document][1].
 
 ## Context
 

diff --git a/functional-samples/cookbook.offscreen-dom/manifest.json b/functional-samples/cookbook.offscreen-dom/manifest.json
@@ -1,6 +1,7 @@
 {
   "name": "Offscreen API - DOM Parsing",
   "version": "1.0",
+  "description": "Shows how to use DOMParser in an extension service worker using the offscreen document.",
   "manifest_version": 3,
   "background": {
     "service_worker": "background.js"

diff --git a/functional-samples/cookbook.sidepanel-global/manifest.json b/functional-samples/cookbook.sidepanel-global/manifest.json
@@ -2,7 +2,7 @@
   "manifest_version": 3,
   "name": "Global side panel",
   "version": "1.0",
-  "description": "Sidepanel declared only in the manifest visible to all sites",
+  "description": "Shows how to display the same side panel on every site using the Side Panel API.",
   "icons": {
     "16": "images/icon-16.png",
     "48": "images/icon-48.png",

diff --git a/functional-samples/cookbook.sidepanel-multiple/manifest.json b/functional-samples/cookbook.sidepanel-multiple/manifest.json
@@ -2,7 +2,7 @@
   "manifest_version": 3,
   "name": "Multiple side panels",
   "version": "1.0",
-  "description": "Displays welcome side panel on installation, then shows the main panel",
+  "description": "This recipe shows how to use sidePanel.getOptions() to retrieve the current side panel and switch between side panels.",
   "background": {
     "service_worker": "service-worker.js"
   },
@@ -13,4 +13,3 @@
   },
   "permissions": ["sidePanel"]
 }
-