docs: automate doc review with Github Copilot custom instructions (#807)

gooishin · gooishin · commit 3ad912a3e0a9 · 2025-10-14T03:42:26.000Z
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -2,7 +2,7 @@
 
 ### License
 
-<PROJECT NAME> is licensed under the terms in [LICENSE]<link to license file in repo>. By contributing to the project, you agree to the license and copyright terms therein and release your contribution under these terms.
+Edge Developer Kit Reference Scripts is licensed under the terms in [LICENSE](./LICENSE). By contributing to the project, you agree to the license and copyright terms therein and release your contribution under these terms.
 
 ### Sign your work
 
diff --git a/README.md b/README.md
@@ -5,7 +5,7 @@
 **Transform your Intel® hardware into a powerful AI and edge computing platform in minutes, not hours.**
 
 
-Whether you're an ODM/OEM developer, AI/ML engineer, university student, or hardware enthusiast, this repository provides everything you need to unlock the full potential of Intel® latest processors and GPUs.
+Whether you're an ODM/OEM developer, AI/ML engineer, university student, or hardware enthusiast, this repository provides everything you need to unlock the full potential of Intel®'s latest processors and GPUs.
 
 
 This repository provides simplified developer kit reference setup scripts for various Intel® platforms and GPUs.
@@ -21,13 +21,13 @@ This repository provides simplified developer kit reference setup scripts for va
 | 🏭 **ODM/OEM Developer** | Production-ready platform setup with validated hardware configurations | [Hardware Setup Guide](#-validated-hardware--configurations) |
 | 🤖 **AI/ML Developer** | Ready-to-use AI workloads: LLMs, computer vision, speech processing | [AI Use Cases](#-ai--ml-use-cases) |
 | 🎓 **Student/Researcher** | Learning-oriented tutorials with step-by-step explanations | [Learning Path](./docs/getting-started/README.md) |
-| 🔧 **Hardware Enthusiast** | Experiment with cutting-edge Intel* hardware and software | [Quick Start](#-5-minute-quick-start) |
-| 🏆 **ESQ Users** | System validation and certification for hardware qualification | [ESQ Overview](https://www.intel.com/content/www/us/en/developer/articles/guide/edge-software-device-qualification.html)|
+| 🔧 **Hardware Enthusiast** | Experiment with cutting-edge Intel® hardware and software | [Quick Start](#-5-minute-quick-start) |
+| 🏆 **ESQ Users** | System validation and certification for hardware qualification | [ESQ Overview](https://github.com/open-edge-platform/edge-system-qualification)|
 
 
 ## 🚀 5-Minute Quick Start
 
-**Just bought an Intel developer kit?** Get up and running immediately:
+**Just bought an Intel® developer kit?** Get up and running immediately:
 
 ```bash
 # One command to rule them all
@@ -39,9 +39,9 @@ sudo bash -c "$(wget -qLO - https://raw.githubusercontent.com/intel/edge-develop
 ### 🚀 **Next Steps**
 
 1. **Explore all use cases** from [our gallery](./docs/use-cases.md)
-2. **Discover more ingredients** in [Open Edge Platform Software Catalog](https://edgesoftwarecatalog.intel.com/) and [Open Edge Platform GitHub](https://github.com/open-edge-platform) 
-2. **Join the community** on [GitHub Discussions](https://github.com/intel/edge-developer-kit-reference-scripts/discussions)
-3. **Share your projects** and help others learn!
+2. **Discover more ingredients** in [Open Edge Platform Software Catalog](https://edgesoftwarecatalog.intel.com/) and [Open Edge Platform GitHub*](https://github.com/open-edge-platform) 
+3. **Join the community** on [GitHub* Discussions](https://github.com/intel/edge-developer-kit-reference-scripts/discussions)
+4. **Share your projects** and help others learn!
 
 ## 📋 Table of Contents
 
@@ -56,14 +56,14 @@ sudo bash -c "$(wget -qLO - https://raw.githubusercontent.com/intel/edge-develop
 
 | Product Collection | Code Name | Support | Validated Hardware |
 |--------------|--------------|-------------------|--------------------|
-| Intel® Arc™ Pro B-Series Graphics | Products formerly Battlemage | ✅ Supported | [Intel Arc Pro B60 Creator 24GB](https://www.asrock.com/Graphics-Card/Intel/Intel%20Arc%20Pro%20B60%20Creator%2024GB/) |
+| Intel® Arc™ Pro B-Series Graphics | Products formerly Battlemage | ✅ Supported | [Intel® Arc™ Pro B60 Creator 24GB](https://www.asrock.com/Graphics-Card/Intel/Intel%20Arc%20Pro%20B60%20Creator%2024GB/) |
 | Intel® Arc™ B-Series Graphics | Products formerly Battlemage | ✅ Supported  | |
 | Intel® Arc™ A-Series Graphics | Products formerly Alchemist | ✅ Supported  | |
 | Intel® Core™ Ultra Processors (Series 2) | Products formerly Arrow Lake | ✅ Supported | [Innodisk Intel® Core™ Ultra Series 2 Reference Kit](https://www.innodisk.com/en/blog/intel-core-ultra-series2-reference-kit)<br>[IEI TANK-XM813](https://www.ieiworld.com/tw/product/model.php?II=1099)<br>[AAEON UP Xtreme ARL](https://up-board.org/up-xtreme-arl/)<br>[ASRock Industrial NUC BOX-255H](https://www.asrockind.com/en-gb/NUC%20BOX-255H) |
-| Intel® Core™ Ultra processors (Series 1) | Products formerly Meteor Lake | ✅ Supported | [Seavo* PIR-1014A AIoT Developer Kit](https://www.seavo.com/en/pir_devkit/)<br>[AAEON* UP Xtreme i14](https://up-board.org/up-xtreme-i14/)<br>[ASRock Industrial* NUC BOX-155H](https://www.asrockind.com/en-gb/NUC%20BOX-155H)<br>[Asus* NUC 14 Pro](https://www.asus.com/displays-desktops/nucs/nuc-mini-pcs/asus-nuc-14-pro/) |
-| Intel® Core™ processors (Series 2) | Products formerly Bartlett Lake | ✅ Supported | [ASRock Industrial* iEPF-100000S Series](https://www.asrockind.com/en-gb/iEPF-10000S%20Series) |
-| Intel® 14th Gen Core™ processors | Products formerly Raptor Lake | ✅ Supported | [ASRock Industrial* iEPF-9030S-EW4](https://www.asrockind.com/en-gb/iEPF-9030S-EW4)|
-| Intel® Core™ Processor N-series | Products formerly Twin Lake | ✅ Supported | AAEON RS-UPN-ADLN355-A10-0864 |
+| Intel® Core™ Ultra Processors (Series 1) | Products formerly Meteor Lake | ✅ Supported | [Seavo* PIR-1014A AIoT Developer Kit](https://www.seavo.com/en/pir_devkit/)<br>[AAEON* UP Xtreme i14](https://up-board.org/up-xtreme-i14/)<br>[ASRock Industrial* NUC BOX-155H](https://www.asrockind.com/en-gb/NUC%20BOX-155H)<br>[Asus* NUC 14 Pro](https://www.asus.com/displays-desktops/nucs/nuc-mini-pcs/asus-nuc-14-pro/) |
+| Intel® Core™ Processors (Series 2) | Products formerly Bartlett Lake | ✅ Supported | [ASRock Industrial* iEPF-100000S Series](https://www.asrockind.com/en-gb/iEPF-10000S%20Series) |
+| Intel® 14th Gen Core™ Processors | Products formerly Raptor Lake | ✅ Supported | [ASRock Industrial* iEPF-9030S-EW4](https://www.asrockind.com/en-gb/iEPF-9030S-EW4)|
+| Intel® Core™ Processor N-Series | Products formerly Twin Lake | ✅ Supported | AAEON RS-UPN-ADLN355-A10-0864 |
 
 ## Edge Design Combinations Matrix
 
@@ -116,6 +116,6 @@ We welcome contributions! Check our [Contributing Guide](./CONTRIBUTING.md) to g
 ---
 
 
-**🎉 Ready to start building amazing AI applications with Intel* hardware? Let's go!** → [Choose your first project](./docs/use-cases.md)
+**🎉 Ready to start building amazing AI applications with Intel® hardware? Let's go!** → [Choose your first project](./docs/use-cases.md)
 
 ---
diff --git a/docs/autogenbom.md b/docs/autogenbom.md
@@ -0,0 +1,91 @@
+# Bill of Materials (BOM)
+
+**Generated:** 2025-10-14 01:18:48 UTC
+**Tool:** Intel Edge Developer Kit Reference Scripts
+**Repository:** intel/edge-developer-kit-reference-scripts
+
+This BOM shows the components tracked by the Intel Edge Developer Kit Reference Scripts.
+Users can compare this with their local system using:
+
+```bash
+./print_summary_table.sh
+```
+
+---
+
+## System Configuration
+
+```
+
+==================== System Installation Summary ====================
+Item                      | Value                                   
+------------------------ -+-----------------------------------------
+Kernel Version            | 6.14.0-33-generic                       
+HWE Stack                 | Installed (6.14.0-33.33~24.04.1)        
+Ubuntu Version            | Ubuntu 24.04.3 LTS                      
+NPU Status                | Detected                                
+------------------------ -+-----------------------------------------
+NPU Components            |                                         
+------------------------ -+-----------------------------------------
+NPU Package               | intel-level-zero-npu                    
+NPU Version               | 1.23.0.20250827-17270089246             
+intel-driver-compiler-npu | 1.23.0.20250827-17270089246             
+intel-fw-npu              | 1.23.0.20250827-17270089246             
+intel-level-zero-npu      | 1.23.0.20250827-17270089246             
+level-zero                | 1.22.4                                  
+GPU Type                  | Intel                                   
+GPU Count                 | 3 Intel graphics device(s) detected     
+GPU Driver                | i915 (loaded)                           
+GPU Device 1              | 00:02.0 VGA compatible controller: Intel Corporation Arrow Lake-U [Intel Graphics] (rev 06)
+GPU Device 2              | 03:00.0 VGA compatible controller: Intel Corporation Device e20b
+GPU Device 3              | 80:14.5 Non-VGA unclassified device: Intel Corporation Device 7f2f (rev 10)
+------------------------ -+-----------------------------------------
+GPU Compute Components    |                                         
+------------------------ -+-----------------------------------------
+intel-metrics-discovery   | 1.14.182-0ubuntu1~24.04~ppa1            
+intel-opencl-icd          | 25.35.35096.9-1~24.04~ppa3              
+clinfo                    | 3.0.23.01.25-1build1                    
+intel-gsc                 | 0.9.5-0ubuntu1~24.04~ppa1               
+------------------------ -+-----------------------------------------
+GPU Media Components      |                                         
+------------------------ -+-----------------------------------------
+intel-media-va-driver-non-free | 25.3.3-0ubuntu1~2.04~ppa1               
+libmfx-gen1               | 25.3.3-0ubuntu1~24.04~ppa1              
+libvpl2                   | 1:2.15.0-0ubuntu1~24.04~ppa1            
+libvpl-tools              | 1.4.0-0ubuntu1~24.04~ppa1               
+libva-glx2                | 2.22.0-1ubuntu1~24.04~ppa1              
+va-driver-all             | 2.22.0-1ubuntu1~24.04~ppa1              
+vainfo                    | 2.22.0-0ubuntu1~24.04~ppa1              
+intel-ocloc               | 25.35.35096.9-1~24.04~ppa3              
+------------------------ -+-----------------------------------------
+GPU Dependencies          |                                         
+------------------------ -+-----------------------------------------
+curl                      | 8.5.0-2ubuntu10.6                       
+wget                      | 1.21.4-1ubuntu4.1                       
+gpg-agent                 | 2.4.4-2ubuntu17.3                       
+software-properties-common | 0.99.49.3                               
+pciutils                  | 1:3.10.0-2build1                        
+------------------------ -+-----------------------------------------
+OpenVINO Components       |                                         
+------------------------ -+-----------------------------------------
+OpenVINO Python           | Not Installed                           
+------------------------ -+-----------------------------------------
+Development Toolchain     |                                         
+------------------------ -+-----------------------------------------
+gcc                       | 13.3.0                                  
+g++                       | 13.3.0                                  
+cmake                     | 3.28.3                                  
+make                      | 4.3                                     
+python3                   | 3.12.3                                  
+pip3                      | 24.0                                    
+git                       | 2.43.0                                  
+docker                    | 28.5.1                                  
+docker-compose            | Not Installed                           
+------------------------ -+-----------------------------------------
+Platform Status           | [✓] Platform is configured            
+=====================================================================
+```
+
+---
+
+*BOM Generated by Intel Edge Developer Kit Reference Scripts*
diff --git a/docs/faq.md b/docs/faq.md
@@ -1,6 +1,6 @@
 # Frequently Asked Questions (FAQ)
 
-Quick answers to common questions about Intel Edge Developer Kits.
+Quick answers to common questions about Intel® Edge Developer Kits.
 
 ## Table of Contents
 
@@ -21,10 +21,10 @@ Quick answers to common questions about Intel Edge Developer Kits.
 4. Join our [community discussions](https://github.com/intel/edge-developer-kit-reference-scripts/discussions) to ask questions
 
 ### **Q: Do I need to buy specific hardware?**
-**A:** The scripts work with many Intel platforms, but we recommend:
-- **Students/Beginners:** Any Core Ultra system with integrated graphics
-- **Professionals:** Core Ultra + Intel Arc GPU (B580 or better)
-- **Researchers:** High-end CPU + Arc B60 Pro for maximum performance
+**A:** The scripts work with many Intel® platforms, but we recommend:
+- **Students/Beginners:** Any Intel® Core™ Ultra system with integrated graphics
+- **Professionals:** Intel® Core™ Ultra + Intel® Arc™ GPU (B580 or better)
+- **Researchers:** High-end CPU + Intel® Arc™ B60 Pro for maximum performance
 
 Check our [Hardware Selection Guide](getting-started/hardware-selection.md) for detailed recommendations.
 
@@ -36,18 +36,18 @@ Check our [Hardware Selection Guide](getting-started/hardware-selection.md) for
 
 ## Hardware Compatibility
 
-### **Q: Is my Intel hardware supported?**
+### **Q: Is my Intel® hardware supported?**
 **A:** Check the [compatibility matrix](../README.md#-validated-hardware--configurations). Supported platforms include:
 - Intel® Core™ Ultra (Series 1 & 2)
 - Intel® Arc™ Graphics (A-Series, B-Series)
 - Intel® 14th Gen Core™ processors
 - Intel® Core™ N-series
 
 
-### **Q: What about older Intel hardware?**
+### **Q: What about older Intel® hardware?**
 **A:** Older hardware may work with reduced functionality:
-- **10th-12th Gen Intel CPUs:** Basic functionality, no NPU features
-- **Older Intel GPUs:** Limited AI acceleration
+- **10th-12th Gen Intel® CPUs:** Basic functionality, no NPU features
+- **Older Intel® GPUs:** Limited AI acceleration
 - **Very old systems:** May require manual driver installation
 
 For best results, use hardware from our [validated list](../README.md#-validated-hardware--configurations).
diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -1,6 +1,6 @@
-# Getting Started with Intel Edge Developer Kits
+# Getting Started with Intel® Edge Developer Kits
 
-Welcome to Intel's edge computing ecosystem! This guide will help you get up and running quickly, regardless of your experience level.
+Welcome to Intel®'s edge computing ecosystem! This guide will help you get up and running quickly, regardless of your experience level.
 
 ## Table of Contents
 
@@ -13,18 +13,18 @@ Welcome to Intel's edge computing ecosystem! This guide will help you get up and
 ### Step 1: Prepare Your System
 
 **Required:**
-- Ubuntu 24.04 LTS Desktop ([Download](https://releases.ubuntu.com/noble/))
+- Ubuntu* 24.04 LTS Desktop ([Download](https://releases.ubuntu.com/noble/))
 - Internet connection
 - Administrator (sudo) access
 
 **Recommended:**
 - 16GB RAM minimum
 - 100GB free disk space
-- Supported Intel hardware ([Check compatibility](../README.md/#-validated-hardware--configurations))
+- Supported Intel® hardware ([Check compatibility](../README.md/#-validated-hardware--configurations))
 
 ### Step 2: Enable Hardware Features
 
-**For Intel Arc Graphics:**
+**For Intel® Arc™ Graphics:**
 1. Access BIOS/UEFI settings
 2. Enable "Resizable BAR" or "Above 4G Decoding"
 3. Save and reboot
@@ -113,7 +113,7 @@ Log file saved: /var/log/intel-platform-installer.log
 
 ### Quick Test: Chat Interface
 
-Let's deploy a ChatGPT-like interface running locally:
+Let's deploy a ChatGPT*-like interface running locally:
 
 ```bash
 cd usecases/ai/openwebui-ollama
@@ -125,13 +125,13 @@ docker compose up -d
 **What you get:**
 - Private AI chat interface
 - No data sent to external servers
-- Runs entirely on your Intel hardware
+- Runs entirely on your Intel® hardware
 
 ### Understanding What Happened
 
-1. **Hardware Detection:** The installer identified your specific Intel platform
+1. **Hardware Detection:** The installer identified your specific Intel® platform
 2. **Driver Installation:** GPU, NPU, and other drivers were configured
-3. **AI Framework:** OpenVINO and supporting tools were installed
+3. **AI Framework:** Intel® Distribution of OpenVINO™ Toolkit and supporting tools were installed
 4. **Optimization:** System was tuned for your hardware configuration
 
 ## Next Steps
@@ -147,8 +147,8 @@ docker compose up -d
 
 ### 🤝 **Join the Community**
 
-- **Questions?** → [GitHub Discussions](https://github.com/intel/edge-developer-kit-reference-scripts/discussions)
-- **Issues?** → [GitHub Issues](https://github.com/intel/edge-developer-kit-reference-scripts/issues)
+- **Questions?** → [GitHub* Discussions](https://github.com/intel/edge-developer-kit-reference-scripts/discussions)
+- **Issues?** → [GitHub* Issues](https://github.com/intel/edge-developer-kit-reference-scripts/issues)
 - **Show & Tell** → Share your projects in discussions!
 
 ---
diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md
@@ -5,7 +5,7 @@
 - [Common Issues](#common-issues)
 - [Platform-Specific Issues](#platform-specific-issues)
 - [Log Files & Troubleshooting Steps](#log-files--troubleshooting-steps)
-- [Intel Camera Systems Troubleshooting Guide](../usecases/camera/TROUBLESHOOTING.md)
+- [Intel® Camera Systems Troubleshooting Guide](../usecases/camera/TROUBLESHOOTING.md)
 
 ### Common Issues
 
@@ -28,7 +28,7 @@ Please install HWE kernel: sudo apt install linux-generic-hwe-24.04
 - Add to appropriate platform list
 
 **NPU Not Detected:**
-- Confirm you are using a Core Ultra platform
+- Confirm you are using an Intel® Core™ Ultra platform
 - Check for NPU device: `ls /dev/intel-npu*`
 - If missing, reboot the system and rerun the installer
 
@@ -43,7 +43,7 @@ Please install HWE kernel: sudo apt install linux-generic-hwe-24.04
 During installation, logs are displayed in real time. For deeper troubleshooting, consult these sources:
 
 - **APT Package Logs:** `/var/log/apt/`
-- **Docker Logs:** `docker logs [container_name]`
+- **Docker* Logs:** `docker logs [container_name]`
 - **NPU Driver Logs:** `/var/log/intel-npu.log`
 - **Installer Output:** Review terminal messages for errors or warnings
 
diff --git a/docs/use-cases.md b/docs/use-cases.md
diff --git a/print_summary_table.sh b/print_summary_table.sh
