DOCS-1601 - Remove accordion tags from FAQ sections and update style guide#6668
Open
JV0812 wants to merge 2 commits into
Open
DOCS-1601 - Remove accordion tags from FAQ sections and update style guide#6668JV0812 wants to merge 2 commits into
JV0812 wants to merge 2 commits into
Conversation
…guide Removed <details> and <summary> accordion tags from FAQ sections across 7 documentation files (67 total accordions). FAQ content is now displayed as bold headings followed by visible answers, improving accessibility, SEO, and AI citation capabilities. Updated the style guide with comprehensive guidance on when to use and NOT use collapsible sections: - Added table format with clear DO/DON'T guidelines for 10 use cases - Documented that accordion tags violate GEO (Generative Engine Optimization) principles - Explained that AI tools cannot properly cite content hidden in accordions - Added requirement for title attribute in <details> tags for accessibility - Provided proper FAQ formatting examples - Preserved existing visual examples Changes: - Converted 67 FAQ accordion items to visible bold format - Updated 7 FAQ documentation files - Enhanced style guide with table-based guidance - Added GEO and AI citation best practices Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Purpose of this pull request
This PR removes
<details>and<summary>accordion tags from FAQ sections to improve accessibility, SEO, and AI citation capabilities. It also updates the style guide with comprehensive guidance on when to use (and when NOT to use) collapsible sections.Summary
Removed accordion tags from 7 documentation files containing FAQ sections (67 total accordion items). FAQ content is now displayed using bold question headings followed by visible answers. This change ensures FAQ content is immediately visible, scannable, and properly indexed by search engines and AI tools.
Updated the contributing style guide with:
What changed
FAQ Documentation (7 files, 67 accordions removed):
docs/search/mobot.md(24 items)docs/api/mcp-server.md(3 items)docs/get-started/sumo-logic-ui.md(6 items)docs/get-started/ai-machine-learning.md(11 items)docs/cse/get-started-with-cloud-siem/soc-analyst-agent.md(9 items)docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/microsoft-graph-azure-ad-reporting-source.md(1 item)docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/universal-connector-source.md(13 items)Style Guide:
<details>tags<details>tagsBefore & After
Before:
After:
Why this change matters
Testing Plan
<details>tags (code samples, installation methods) are properly usedTicket (if applicable)
https://sumologic.atlassian.net/browse/DOCS-1601
Select the type of change