Cleaned up lots of formatting and organization (#452)

- Improved the readability of the content. - Fixed some broken content. - Improved Markdown formatting. - Added link to the Console application to help clarify what was meant.
Adobe-CEP · May 18, 2023 · 403c3cd · 403c3cd
1 parent 9b24045
commit 403c3cd
Showing 1 changed file with 32 additions and 44 deletions.
diff --git a/CEP_11.x/Documentation/Debugging Handbook.md b/CEP_11.x/Documentation/Debugging Handbook.md
@@ -2,72 +2,61 @@
 
 ### 1.1 Checking & Editing Logging Settings
 
- - Set Log Level to 6 → defaults write com.adobe.CSXS.11 LogLevel 6
- - Check Log Level → defaults read com.adobe.CSXS.11 LogLevel
+- **Set Log Level to 6:** `defaults write com.adobe.CSXS.11 LogLevel 6`
+- **Check Log Level:** `defaults read com.adobe.CSXS.11 LogLevel`
 
 ### 1.2. Extension Folders
 
- - System Extension Folder → /Library/Application
-   Support/Adobe/CEP/extensions
- - User Extension Folder → ~/Library/Application   
-   Support/Adobe/CEP/extensions
- - Product Extension Folders → ${PP}/CEP/extensions
+- **System Extension Folder:** `/Library/Application Support/Adobe/CEP/extensions`
+- **User Extension Folder:** `~/Library/Application Support/Adobe/CEP/extensions`
+- **Product Extension Folders:** `${PP}/CEP/extensions`
 
 ### 1.3. Logs Folder
 
- - CEP Logs Folder → ~/Library/Logs/CSXS
- - CEP Logs → CEP`<Version Number>`-`<Product ID>`.log e.g CEP11-ILST.log
- - CEPHTMLEngine Broser Logs → CEPHTMLEngine-`<versionNumber>`-`<HostID>`-`<HostVersion>`-`<ExtensionID>`.log (e.g
-   CEPHtmlEngine11-ILST-26.0.3-com.adobe.illustrator.OnBoarding.
- - CEPHTMLEngine Renderer Logs → CEPHTMLEngine-`<versionNumber>`-`<HostID>`-`<HostVersion>`-`<ExtensionID>`-renderer.log
-   (e.g CEPHtmlEngine11-ILST-26.0.3-com. 
-
+- **CEP Logs Folder:** `~/Library/Logs/CSXS`
+- **CEP Log Name Format:** CEP`<Version Number>`-`<Product ID>`.log
+  - **Example:** CEP11-ILST.log
+- **CEPHTMLEngine Broser Log Name Format:** CEPHTMLEngine-`<versionNumber>`-`<HostID>`-`<HostVersion>`-`<ExtensionID>`.log
+  - **Example:** CEPHtmlEngine11-ILST-26.0.3-com.adobe.illustrator.OnBoarding.log
+- **CEPHTMLEngine Renderer Log Name Format:** CEPHTMLEngine-`<versionNumber>`-`<HostID>`-`<HostVersion>`-`<ExtensionID>`-renderer.log
+  - **Example:** CEPHtmlEngine11-ILST-26.0.3-com.adobe.illustrator.OnBoarding-renderer.log
+
 ### 1.4. Crash Dump
- - Get it in the Console App
+ - Find them in the [Console application](https://support.apple.com/guide/console/welcome/mac).
 
 ## 2. Windows
 
 ### 2.1. Checking & Editing Logging Settings
 
- - Set Log Level to 6 → regedit >
-   HKEY_CURRENT_USER/Software/Adobe/CSXS.11 > Set LogLevel as 6
- - Check Log Level → regedit > HKEY_CURRENT_USER/Software/Adobe/CSXS.11
+ - **Set Log Level to 6:** `regedit` > `HKEY_CURRENT_USER/Software/Adobe/CSXS.11` > Set `LogLevel` as `6`
+ - **Check Log Level:** `regedit` > `HKEY_CURRENT_USER/Software/Adobe/CSXS.11`
 
 ### 2.2. Extensions Folders
 
- - System Extension Folder → C:\Program Files (x86)\Common
-   Files\Adobe\CEP\extensions
-
-- User Extension Folder → %AppData%\Roaming\Adobe\CEP\extensions
-
-- Product Extension Folders → ${PP}\CEP\extensions
+- **System Extension Folder:** `C:\Program Files (x86)\Common Files\Adobe\CEP\extensions`
+- **User Extension Folder:** `%AppData%\Roaming\Adobe\CEP\extensions`
+- **Product Extension Folders:** `${PP}\CEP\extensions`
 
 ### 2.3. Logs Folders
 
-- CEP Logs Folder → %temp%
-
-- CEP Logs → CEP`<Version Number>`-`<Product ID>`.log e.g CEP11-ILST.log
-
-- CEPHTMLEngine Broser Logs → CEPHTMLEngine-`<versionNumber>`-`<HostID>`-`<HostVersion>`-`<ExtensionID>`.log (e.g CEPHtmlEngine11-ILST-26.0.3-com.adobe.illustrator.OnBoarding.log)
-
-- CEPHTMLEngine Renderer Logs → CEPHTMLEngineCEPHTMLEngine-`<versionNumber>`-`<HostID>`-`<HostVersion>`-`<ExtensionID>`-renderer.log (e.g CEPHtmlEngine11-ILST-26.0.3-com.adobe.illustrator.OnBoarding-renderer.log)
-
-
+- **CEP Logs Folder:** `%temp%`
+- **CEP Log Name Format:** CEP`<Version Number>`-`<Product ID>`.log e.g CEP11-ILST.log
+- **CEPHTMLEngine Broser Log Name Format:** CEPHTMLEngine-`<versionNumber>`-`<HostID>`-`<HostVersion>`-`<ExtensionID>`.log
+  - **Example:** CEPHtmlEngine11-ILST-26.0.3-com.adobe.illustrator.OnBoarding.log
+- **CEPHTMLEngine Renderer Log Name Format:** CEPHTMLEngineCEPHTMLEngine-`<versionNumber>`-`<HostID>`-`<HostVersion>`-`<ExtensionID>`-renderer.log
+  - **Example:** CEPHtmlEngine11-ILST-26.0.3-com.adobe.illustrator.OnBoarding-renderer.log
 
 ### 2.4 Crash Dump
 
- - %AppData%\Roaming\Adobe\CRLogs\dumps
+ - `%AppData%\Roaming\Adobe\CRLogs\dumps`
 
 ## 3. Debugging Tools
 
-- Add [.debug](./.debug) file inside the extension folder which should be here 
-- - Mac → /Library/Application
-   Support/Adobe/CEP/extensions
-   - Windows →  C:\Program Files (x86)\Common
-   Files\Adobe\CEP\extensions
-
-<Code> Code
-
+- Add file called [.debug](./.debug) to the root of the extension folder. This folder should be in one of the following locations:
+  - **Mac:** `/Library/Application Support/Adobe/CEP/extensions`
+  - **Windows:**  `C:\Program Files (x86)\Common Files\Adobe\CEP\extensions`
+- Example contents:
+    ```xml
     <?xml version="1.0" encoding="UTF-8"?> 
     <ExtensionList>
         <Extension Id="com.adobe.cep.exchange.extension.panel">
@@ -86,5 +75,4 @@
             </HostList>
         </Extension>
     </ExtensionList>
-
-
+    ```