solutions:reference-designs:adrd8012-01z: Update to latest status

.devcontainer.json

@@ -12,16 +12,16 @@
     }
   },
   "waitFor": "onCreateCommand",
-  "updateContentCommand": "python -m venv venv ; source venv/bin/activate ; pip install -r docs/requirements.txt",
+  "updateContentCommand": "pip install -r docs/requirements.txt",
   "postCreateCommand": "",
   "postAttachCommand": {
-    "server": "source venv/bin/activate ; (cd docs ; adoc serve -p 8000)"
+    "server": "adoc serve -p 8080"
   },
   "portsAttributes": {
     "8000": {
       "label": "live-editor",
       "onAutoForward": "openPreview"
     }
   },
-  "forwardPorts": [8000]
+  "forwardPorts": [8080]
 }

.gitattributes

@@ -1,6 +1,8 @@
 *.jpg filter=lfs diff=lfs merge=lfs -text
 *.jpeg filter=lfs diff=lfs merge=lfs -text
 *.png filter=lfs diff=lfs merge=lfs -text
+*.gif filter=lfs diff=lfs merge=lfs -text
+*.webp filter=lfs diff=lfs merge=lfs -text
 *.zip filter=lfs diff=lfs merge=lfs -text
 *.tar.gz filter=lfs diff=lfs merge=lfs -text
 *.tar filter=lfs diff=lfs merge=lfs -text
@@ -12,3 +14,4 @@
 *.odp filter=lfs diff=lfs merge=lfs -text
 *.ods filter=lfs diff=lfs merge=lfs -text
 *.bin filter=lfs diff=lfs merge=lfs -text
+*.lfs.svg filter=lfs diff=lfs merge=lfs -text

.github/scripts/case.py

@@ -0,0 +1,121 @@
+#!/usr/bin/env python3
+"""
+Find and fix uppercase characters in filenames in docs folder.
+"""
+
+import os
+import argparse
+from pathlib import Path
+from collections import defaultdict
+
+GITHUB_ACTIONS = os.environ.get("GITHUB_ACTIONS", "false") == "true"
+
+if GITHUB_ACTIONS:
+    warning = "{file}\n::warning file={file}::{message}"
+    error = "{file}\n::error file={file}::{message}"
+    notice = "::notice ::{message}"
+else:
+    warning = "WARNING: {message}"
+    error = "ERROR: {message}"
+    notice = "INFO: {message}"
+
+
+def find_uppercase_files(root_dir):
+    """Find files with uppercase letters, return (files_to_fix, conflicts)."""
+    files = []
+    seen = defaultdict(list)
+
+    for root, _, filenames in os.walk(root_dir):
+        if '_build' in root or '__pycache__' in root:
+            continue
+        for name in filenames:
+            if name != name.lower() and name != "Makefile":
+                path = Path(root) / name
+                new_path = Path(root) / name.lower()
+                seen[str(new_path)].append(str(path))
+                files.append({'path': path, 'new_name': name.lower(), 'new_path': new_path})
+
+    conflicts = {k: v for k, v in seen.items() if len(v) > 1}
+    return files, conflicts
+
+
+def find_references(root_dir, filename):
+    """Find .rst/.md files referencing filename."""
+    refs = []
+    for root, _, filenames in os.walk(root_dir):
+        if '_build' in root or '__pycache__' in root:
+            continue
+        for name in filenames:
+            if name.endswith(('.rst', '.md')):
+                path = Path(root) / name
+                try:
+                    content = path.read_text(encoding='utf-8')
+                    if filename in content:
+                        refs.append(path)
+                except (UnicodeDecodeError, PermissionError):
+                    pass
+    return refs
+
+
+def main():
+    parser = argparse.ArgumentParser(description='Find and fix uppercase filenames in docs')
+    parser.add_argument('--fix', action='store_true', help='Apply fixes')
+    parser.add_argument('--dry-run', action='store_true', help='Show what would change')
+    args = parser.parse_args()
+
+    root_dir = 'docs'
+    if not os.path.isdir(root_dir):
+        print(error.format(file=root_dir, message="Directory does not exist"))
+        return 1
+
+    files, conflicts = find_uppercase_files(root_dir)
+
+    if conflicts:
+        for target, sources in conflicts.items():
+            for src in sources:
+                print(warning.format(file=src, message=f"Conflict: would become '{target}'"))
+        print(error.format(file="", message=f"{len(conflicts)} naming conflicts found"))
+        return 1
+
+    if not files:
+        print("No files with uppercase characters found")
+        return 0
+
+    for f in files:
+        print(warning.format(file=str(f['path']), message=f"Should be: {f['new_name']}"))
+
+    print(f"\nFound {len(files)} files with uppercase characters\n")
+
+    if not args.fix and not args.dry_run:
+        print(notice.format(message="Fix case issues by running `python3 .github/scripts/case.py --fix`"))
+        return 0
+
+    for f in files:
+        old_path, new_path, new_name = f['path'], f['new_path'], f['new_name']
+        old_name = old_path.name
+
+        refs = find_references(root_dir, old_name)
+        for ref in refs:
+            if args.fix:
+                content = ref.read_text(encoding='utf-8')
+                ref.write_text(content.replace(old_name, new_name), encoding='utf-8')
+                print(f"  Updated {ref}")
+            else:
+                print(f"  Would update {ref}")
+
+        if args.fix:
+            os.rename(old_path, new_path)
+            print(f"Renamed: {old_name} -> {new_name}")
+        else:
+            print(f"Would rename: {old_name} -> {new_name}")
+
+    if args.dry_run:
+        print("\nDry run complete, no changes made")
+    else:
+        print(f"\nFixed {len(files)} files")
+
+    return 0
+
+
+if __name__ == '__main__':
+    exit(main())

.github/scripts/dangling.py

@@ -0,0 +1,166 @@
+#!/usr/bin/env python3
+"""
+Find and remove dangling files (not referenced in any .rst files) in docs folder.
+"""
+
+import os
+import argparse
+import subprocess
+from pathlib import Path
+
+GITHUB_ACTIONS = os.environ.get("GITHUB_ACTIONS", "false") == "true"
+
+if GITHUB_ACTIONS:
+    warning = "{file}\n::warning file={file}::{message}"
+    error = "{file}\n::error file={file}::{message}"
+    notice = "::notice ::{message}"
+else:
+    warning = "WARNING: {file} - {message}"
+    error = "ERROR: {message}"
+    notice = "INFO: {message}"
+
+EXCLUDE_FILES = {
+    'conf.py', 'Makefile', 'make.bat', '.gitignore', '.gitattributes',
+    'requirements.txt',
+    'custom.css', 'adi_logo.svg', 'icon.svg',
+}
+
+EXCLUDE_EXTENSIONS = {'.rst', '.md'}
+
+SKIP_DIRS = {'_build', '__pycache__', '.git'}
+
+
+def find_all_files(root_dir):
+    """Find all files that could potentially be dangling."""
+    files = []
+    for root, dirs, filenames in os.walk(root_dir):
+        dirs[:] = [d for d in dirs if d not in SKIP_DIRS]
+
+        for name in filenames:
+            path = Path(root) / name
+            ext = path.suffix.lower()
+
+            if ext in EXCLUDE_EXTENSIONS:
+                continue
+            if name in EXCLUDE_FILES:
+                continue
+
+            files.append(path)
+
+    return files
+
+
+def find_rst_files(root_dir):
+    """Find all .rst files in the docs folder."""
+    rst_files = []
+    for root, dirs, filenames in os.walk(root_dir):
+        dirs[:] = [d for d in dirs if d not in SKIP_DIRS]
+
+        for name in filenames:
+            if name.endswith('.rst'):
+                rst_files.append(Path(root) / name)
+
+    return rst_files
+
+
+def load_rst_contents(rst_files):
+    """Load contents of all .rst files into a single string for fast searching."""
+    contents = {}
+    for rst_file in rst_files:
+        try:
+            contents[rst_file] = rst_file.read_text(encoding='utf-8')
+        except (UnicodeDecodeError, PermissionError):
+            pass
+    return contents
+
+
+def is_file_referenced(file_path, rst_contents):
+    """Check if a file is referenced in any .rst file."""
+    filename = file_path.name
+
+    for rst_file, content in rst_contents.items():
+        rel_path = os.path.relpath(file_path, rst_file.parent)
+        if rel_path in content:
+            return True
+
+    return False
+
+
+def find_dangling_files(root_dir):
+    """Find files that are not referenced in any .rst file."""
+    all_files = find_all_files(root_dir)
+    rst_files = find_rst_files(root_dir)
+    rst_contents = load_rst_contents(rst_files)
+
+    dangling = []
+    for file_path in all_files:
+        if not is_file_referenced(file_path, rst_contents):
+            dangling.append(file_path)
+
+    return dangling
+
+
+def git_rm(file_path, dry_run=False):
+    """Remove a file using git rm."""
+    if dry_run:
+        print(f"  Would run: git rm {file_path}")
+        return True
+
+    try:
+        result = subprocess.run(
+            ['git', 'rm', str(file_path)],
+            capture_output=True,
+            text=True
+        )
+        if result.returncode == 0:
+            print(f"  Removed: {file_path}")
+            return True
+        else:
+            print(f"  Failed to remove {file_path}: {result.stderr.strip()}")
+            return False
+    except Exception as e:
+        print(f"  Error removing {file_path}: {e}")
+        return False
+
+
+def main():
+    parser = argparse.ArgumentParser(description='Find and remove dangling files in docs')
+    parser.add_argument('--fix', action='store_true', help='Remove dangling files with git rm')
+    parser.add_argument('--dry-run', action='store_true', help='Show what would be removed')
+    args = parser.parse_args()
+
+    root_dir = 'docs'
+    if not os.path.isdir(root_dir):
+        print(error.format(file=root_dir, message="Directory does not exist"))
+        return 1
+
+    dangling = find_dangling_files(root_dir)
+
+    if not dangling:
+        print("No dangling files found")
+        return 0
+
+    for f in dangling:
+        print(warning.format(file=str(f), message="Not referenced in any .rst file"))
+
+    print(f"\nFound {len(dangling)} dangling files\n")
+
+    if not args.fix and not args.dry_run:
+        print(notice.format(message="Remove dangling files by running `python3 .github/scripts/dangling.py --fix`"))
+        return 1
+
+    removed = 0
+    for f in dangling:
+        if git_rm(f, dry_run=args.dry_run):
+            removed += 1
+
+    if args.dry_run:
+        print(f"\nDry run complete, {removed} files would be removed")
+    else:
+        print(f"\nRemoved {removed} dangling files")
+
+    return 0
+
+
+if __name__ == '__main__':
+    exit(main())

.github/scripts/sort-vale.sh

@@ -0,0 +1,6 @@
+#!/bin/bash
+
+file=".github/styles/config/vocabularies/Base/accept.txt"
+{ grep '^[[:upper:]]' $file | sort -u; \
+  grep '^\['          $file | sort -u; \
+  grep '^[[:lower:]]' $file | sort -u; } > tmp && mv tmp $file