Fix broken links, dead nav entries, duplicate YAML keys, and orphaned pages in documentation
>>> [!note] Migrated issue <!-- Drupal.org comment --> <!-- Migrated from issue #3582359. --> Reported by: [marcus_johansson](https://www.drupal.org/user/385947) Related to !1382 >>> <p>[Tracker]<br> <strong>Update Summary: </strong>[One-line status update for stakeholders]<br> <strong>Short Description: </strong>Fix broken links, dead nav entries, duplicate YAML keys, and orphaned pages in documentation<br> <strong>Check-in Date: </strong>MM/DD/YYYY<br> [/Tracker]</p> <h3 id="summary-problem-motivation">Problem/Motivation</h3> <p>A documentation audit identified several issues in the mkdocs configuration and documentation files that affect the built documentation site. These range from silently dropped configuration due to duplicate YAML keys, to broken links and pages that are invisible to users.</p> <p><strong>Duplicate YAML keys in mkdocs.yml (3 issues - configuration silently lost):</strong></p> <ul> <li>Duplicate <code>features</code> key under <code>theme</code>: <code>header.autohide</code> is silently overwritten and NOT active.</li> <li>Duplicate <code>plugins</code> key: <code>glightbox</code> plugin is silently overwritten and NOT loaded.</li> <li>Duplicate <code>extra</code> key: social links (GitLab, Slack, LinkedIn) are overwritten by the <code>version</code> provider and NOT rendered.</li> </ul> <p><strong>Dead nav links (2 issues - filename typos):</strong></p> <ul> <li><code>agents/testing/ai_agent_test/running_test_group.md</code> in nav, actual file is <code>running_a_test_group.md</code> (missing <code>_a_</code>).</li> <li><code>developers/json_schema_editor.md</code> in nav, actual file is <code>json-schema-editor.md</code> (hyphens vs underscores).</li> </ul> <p><strong>Broken internal links (4 issues):</strong></p> <ul> <li><code>providers/matris.md</code>: link to <code>..developers/call_image_to_image.md</code> is missing a <code>/</code>, should be <code>../developers/call_image_to_image.md</code>.</li> <li><code>modules/field_widget_actions/automators.md</code>: link to <code>../ai_automators/address_automator.md</code> is wrong, should be <code>../ai_automators/examples/address_automator.md</code>.</li> <li><code>agents/testing/ai_agent_test/index.md</code>: DrupalForge link is <code>https:/drupalforge.org</code>, missing <code>//</code>.</li> <li><code>contribute/releases/index.md</code>: "Breaking Changes" row links to <code>release_notes.md</code> instead of <code>breaking_changes.md</code>.</li> </ul> <p><strong>Duplicate nav entry:</strong></p> <ul> <li><code>developers/chat_history_element.md</code> appears twice in nav - under "Helper Services" and under "Form Elements".</li> </ul> <p><strong>Orphaned standalone docs (not in nav and not linked from any other page):</strong></p> <ul> <li><code>developers/ai_provider_configuration_element.md</code> (477 lines) - AI Provider Configuration Form Element</li> <li><code>developers/recipes.md</code> (131 lines) - Recipes</li> <li><code>developers/hostname_filter.md</code> (122 lines) - HostnameFilter Service</li> <li><code>contribute/issue_review_guidelines.md</code> (53 lines) - Issue Review Guidelines</li> <li><code>general/index.md</code> (34 lines) - General Settings for AI Module</li> <li><code>contribute/releases/communicating_a_release.md</code> (29 lines) - Communicating a Release</li> <li><code>modules/ai_observability/index.md</code> (20 lines) - AI Observability</li> <li><code>modules/providers/index.md</code> (10 lines) - AI Providers</li> <li><code>modules/vdb_providers/index.md</code> (10 lines) - AI VDB Providers</li> <li><code>examples/dropai_provider/README.md</code> (8 lines) - DropAI provider example</li> <li>7 automator example pages under <code>modules/ai_automators/examples/</code> (70-139 lines each)</li> </ul> <p><strong>Empty file:</strong></p> <ul> <li><code>modules/ai_automators/automator_types/llm_simple_text.md</code> - 0 lines, completely empty.</li> </ul> <h3 id="summary-proposed-resolution">Proposed resolution</h3> <ul> <li>Merge duplicate YAML keys in <code>mkdocs.yml</code> so all values are under a single key: combine <code>features</code>, <code>plugins</code>, and <code>extra</code> into single blocks.</li> <li>Fix the 2 dead nav links by correcting the filenames to match the actual files on disk.</li> <li>Fix the 4 broken internal links in the doc files.</li> <li>Remove the duplicate nav entry for <code>chat_history_element.md</code> (keep it under Form Elements only, or under Helper Services only).</li> <li>Add orphaned standalone docs to the <code>mkdocs.yml</code> nav in appropriate sections, or link them from relevant parent pages.</li> <li>Either write content for the empty <code>llm_simple_text.md</code> or remove it.</li> </ul> <h3 id="summary-ai-usage">AI usage (if applicable)</h3> <p>[x] AI Assisted Issue<br> This issue was generated with AI assistance, but was reviewed and refined by the creator.</p> <p>[ ] AI Assisted Code<br> [ ] AI Generated Code<br> [ ] Vibe Coded</p> <p>- <strong>This issue was created with the help of AI</strong></p>
issue