Skip to content

DOCS-1684 - Deduplicate GEO rules across geo-optimize and seo-audit#6899

Merged
kimsauce merged 3 commits into
mainfrom
DOCS-1684
Jul 15, 2026
Merged

DOCS-1684 - Deduplicate GEO rules across geo-optimize and seo-audit#6899
kimsauce merged 3 commits into
mainfrom
DOCS-1684

Conversation

@kimsauce

Copy link
Copy Markdown
Collaborator

Purpose of this pull request

This pull request removes duplicated GEO rules from /geo-optimize and /seo-audit, deferring to geo-guide/SKILL.md as the single source of truth for the Five GEO Principles (BLUF, one page one question, question-style headings, FAQ sections, structured metadata). Same pattern already fixed in DOCS-1640 for sumo-style vs audit-doc.

Changes:

  • geo-optimize.md Step 2: references the skill for BLUF, one-page-one-question, and question-heading checks instead of restating them; kept the AEO-specific signals the skill doesn't cover (factual density, structured content, summary section). Also removed an internal duplicate — "headings phrased as questions" appeared twice in the same step.
  • seo-audit.md Step 5: references the skill for the GEO principles not already checked elsewhere in the file (question headings and keywords are covered by Steps 3–4). While reconciling this, found the BLUF check overlapped with Step 4's existing opening-paragraph check, so narrowed it to section-level only. Also found "one page, one question" was only half-covered (self-containedness, but not "does this page try to answer multiple questions") and FAQ sections weren't checked at all — added both.
  • Standardized the description field length rule (140–160 target, Warning if under 100 or over 160, Suggestion for the 100–139 gap that was previously unflagged entirely) across audit-doc.md and seo-audit.md, which had drifted to slightly different wording.

Select the type of change

  • Minor Changes - Typos, formatting, slight revisions
  • Update Content - Revisions, updating sections
  • New Content - New features, sections, pages, tutorials
  • Site and Tools - .clabot, version updates, maintenance, dependencies, new packages for the site (Docusaurus, Gatsby, React, etc.)

Ticket (if applicable)

https://sumologic.atlassian.net/browse/DOCS-1684

…ide skill

geo-guide/SKILL.md is now the authoritative source for the Five GEO
Principles (BLUF, one page one question, question-style headings, FAQ
sections, structured metadata). /geo-optimize and /seo-audit each
maintained their own inline GEO checklists that duplicated this,
risking drift between the skill and the commands (same pattern
already fixed in DOCS-1640 for sumo-style vs audit-doc).

- geo-optimize.md Step 2: reference the skill for BLUF, one-page-one-
  question, and question-heading checks; keep the AEO-specific signals
  the skill doesn't cover (factual density, structured content,
  summary section); removed an internal duplicate ("headings as
  questions" appeared twice in the same step)
- seo-audit.md Step 5: reference the skill for the GEO principles not
  already checked elsewhere in the file (question headings and
  keywords are covered by Steps 3-4). Narrowed the BLUF check to
  section-level only, since Step 4 already checks the page's opening,
  and added the previously-missing "one clearly scoped question" and
  FAQ-section checks (principle 2 was only half-covered; principle 4
  wasn't checked at all)
- Standardized the description-length rule (140-160 target, Warning
  under 100/over 160, Suggestion for the 100-139 gap that was
  previously unflagged) across audit-doc.md and seo-audit.md

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@kimsauce kimsauce self-assigned this Jul 13, 2026
@cla-bot cla-bot Bot added the cla-signed Contributor approved, listed in .clabot file label Jul 13, 2026

@JV0812 JV0812 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed the GEO dedup. Verified the "already covered" claims hold: seo-audit Step 4 (AEO) genuinely covers question-format headings and the opening-paragraph answer check, so re-scoping BLUF to section-level and deferring to geo-guide/SKILL.md drops no coverage — and it adds the previously-missing one-page-one-question and FAQ checks. The Five GEO Principles reference matches the skill exactly, the geo-optimize cleanup preserves the AEO-specific signals, and the description-length rule (140–160; Warning <100 or >160; Suggestion 100–139) is now consistent across audit-doc and seo-audit. No site-build impact since these are .claude/commands files. LGTM.

Optional nit: the SKILL.md links are repo-root paths; a true relative link from .claude/commands/ would be ../skills/geo-guide/SKILL.md — cosmetic since these files aren't site-rendered.

@kimsauce
kimsauce added this pull request to the merge queue Jul 14, 2026
@github-merge-queue
github-merge-queue Bot removed this pull request from the merge queue due to failed status checks Jul 14, 2026
@kimsauce
kimsauce enabled auto-merge July 15, 2026 15:44
@kimsauce
kimsauce added this pull request to the merge queue Jul 15, 2026
Merged via the queue into main with commit 01dc3d0 Jul 15, 2026
5 checks passed
@kimsauce
kimsauce deleted the DOCS-1684 branch July 15, 2026 15:54
shreyashnaik-sumo pushed a commit to shreyashnaik-sumo/sumologic-documentation that referenced this pull request Jul 20, 2026
…ide skill (SumoLogic#6899)

geo-guide/SKILL.md is now the authoritative source for the Five GEO
Principles (BLUF, one page one question, question-style headings, FAQ
sections, structured metadata). /geo-optimize and /seo-audit each
maintained their own inline GEO checklists that duplicated this,
risking drift between the skill and the commands (same pattern
already fixed in DOCS-1640 for sumo-style vs audit-doc).

- geo-optimize.md Step 2: reference the skill for BLUF, one-page-one-
  question, and question-heading checks; keep the AEO-specific signals
  the skill doesn't cover (factual density, structured content,
  summary section); removed an internal duplicate ("headings as
  questions" appeared twice in the same step)
- seo-audit.md Step 5: reference the skill for the GEO principles not
  already checked elsewhere in the file (question headings and
  keywords are covered by Steps 3-4). Narrowed the BLUF check to
  section-level only, since Step 4 already checks the page's opening,
  and added the previously-missing "one clearly scoped question" and
  FAQ-section checks (principle 2 was only half-covered; principle 4
  wasn't checked at all)
- Standardized the description-length rule (140-160 target, Warning
  under 100/over 160, Suggestion for the 100-139 gap that was
  previously unflagged) across audit-doc.md and seo-audit.md

Co-authored-by: Claude Sonnet 5 <noreply@anthropic.com>
shreyashnaik-sumo added a commit to shreyashnaik-sumo/sumologic-documentation that referenced this pull request Jul 20, 2026
SumoLogic#6900)

* CSOAR-5161:Implement a Schedule Action in the CrowdStrike Falcon Intelligence integration

* CSOAR-5161:version change1.10

* Added note into post installation steps of all aws v2 migrated app do… (SumoLogic#6902)

* added note into post installation steps of all aws v2 migrated app documentation

* updated elastic-container-service-container-insights-cloudwatch.md

* Convert AWS app post-install note to a reuse component

Extract the "do not delete or modify installed content" note into a shared
reuse snippet and import it across the 14 AWS v2 app docs, so the wording is
maintained in one place. Also drop "please" per the Sumo style guide.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

---------

Co-authored-by: Amee Lepcha <amee.lepcha.ctr@sumologic.com>
Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* DOCS-1725 - Update SAML setup screenshots and button label (SumoLogic#6908)

* DOCS-1725 - Update SAML setup screenshots and button label

Refresh the require-saml and saml-config-list screenshots and update the
text to reference the "+ Add Configuration" button.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* DOCS-1725 - Update SAML reuse snippet button label and screenshots

Update the reuse SAML snippet to reference the "+ Add Configuration"
button and refresh the allow-users and require-saml screenshots.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* DOCS-1725 - Clean up SAML reuse snippet button phrasing

Reword to "click the + Add Configuration button" for clarity and to match
the set-up-saml doc.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* DOCS-1684 - Defer GEO rules in /geo-optimize and /seo-audit to geo-guide skill (SumoLogic#6899)

geo-guide/SKILL.md is now the authoritative source for the Five GEO
Principles (BLUF, one page one question, question-style headings, FAQ
sections, structured metadata). /geo-optimize and /seo-audit each
maintained their own inline GEO checklists that duplicated this,
risking drift between the skill and the commands (same pattern
already fixed in DOCS-1640 for sumo-style vs audit-doc).

- geo-optimize.md Step 2: reference the skill for BLUF, one-page-one-
  question, and question-heading checks; keep the AEO-specific signals
  the skill doesn't cover (factual density, structured content,
  summary section); removed an internal duplicate ("headings as
  questions" appeared twice in the same step)
- seo-audit.md Step 5: reference the skill for the GEO principles not
  already checked elsewhere in the file (question headings and
  keywords are covered by Steps 3-4). Narrowed the BLUF check to
  section-level only, since Step 4 already checks the page's opening,
  and added the previously-missing "one clearly scoped question" and
  FAQ-section checks (principle 2 was only half-covered; principle 4
  wasn't checked at all)
- Standardized the description-length rule (140-160 target, Warning
  under 100/over 160, Suggestion for the 100-139 gap that was
  previously unflagged) across audit-doc.md and seo-audit.md

Co-authored-by: Claude Sonnet 5 <noreply@anthropic.com>

* apply `paths-ignore` to `.claude` directory contents (SumoLogic#6910)

* DOCS-1753 - Update MCP documentation to include a starter skill (SumoLogic#6903)

* DOCS-1753 - Add starter skill to MCP Server doc

Publishes the sumo-log-investigator SKILL.md as a starting point for Claude Code
users, with guidance on how skills help AI agents, how to set one up, and how
automatic vs. explicit (/sumo-log-investigator) invocation works.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

* DOCS-1753 - Fix tool name casing and heading style in MCP Server doc

Align MCP tool identifiers to camelCase, apply sentence case to headings (including inside the embedded SKILL.md example), and link to role capabilities for required scopes.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

* DOCS-1753 - Rename skill to sumo-investigator in MCP Server doc

Garrett confirmed the skill name; update all references from sumo-log-investigator to sumo-investigator.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Sonnet 5 <noreply@anthropic.com>

* DOCS-1759 - Document Flex pricing cost risk in MCP server guide (SumoLogic#6911)

Add a note to the Cost dynamics section flagging that Flex customers' scan-based billing is directly exposed to cost-amplifying log search tool call patterns, unlike ingest-based plans.

Co-authored-by: Claude Sonnet 5 <noreply@anthropic.com>

* DOCS-1753 - Update sumo-investigator skill to Garrett's revised version (SumoLogic#6912)

Follow-up to merged PR SumoLogic#6903. Replace the embedded SKILL.md in the MCP Server
doc with the updated version from review (ganano): drops "log" from the
name/description, switches the frontmatter `triggers:` list to `when_to_use:`,
and trims field-reference and tool-name guidance. Keep section headings in
sentence case per Sumo style, rename the H2 to "Improve investigations with a
skill", and align the auto-invocation description with the new `when_to_use`
frontmatter field.

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* DOCS-1758 - Align AWS and Azure sources documentation structure with the UI (SumoLogic#6918)

* DOCS-1758 - Align AWS sources docs structure with the UI

Surface AWS source types in the Amazon/AWS Sources docs section to match how
they appear grouped in the collection UI:
- Add the Amazon Security Lake tile to the index (was in the sidebar only).
- Cross-list AWS Cost Explorer, AWS IAM Users, and Cloud SIEM AWS EC2
  Inventory (C2C sources) into the Amazon/AWS index and sidebar.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* DOCS-1758 - Add Microsoft source tiles and alphabetize AWS/Microsoft sources

Add index tiles and sidebar entries for Azure Event Hubs (Logs), Microsoft
Azure AD Inventory, Microsoft Exchange Trace Logs, and the MS Graph
(Reporting, Identity Protection, Security API) sources to the Microsoft
Sources section, and alphabetize both the Microsoft and Amazon/AWS source
tiles and sidebar entries.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* CONN-5789:Update Ms Exchange Trace Logs source doc (SumoLogic#6919)

* SUMO-288112 | Apoorv | Add. monitors and update the app doc for PCI Complaince for AWS CloudTrail (SumoLogic#6905)

* SUMO-288112 | Apoorv | Add. monitors and update the app doc

* Refine PCI CloudTrail alert wording and heading casing

Change alert descriptions from "This alert fires" to "This alert is
triggered" and lowercase "for" in the alerts subsection heading to match
the app name.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

---------

Co-authored-by: Amee Lepcha <amee.lepcha.ctr@sumologic.com>
Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* SUMO-28841 | Apoorv | Add. monitors and new screenshots - Amazon GuardDuty  (SumoLogic#6907)

* SUMO-28841 | Apoorv | Add. monitors and new screenshots

* Lowercase "app" in Amazon GuardDuty install heading

Align the "Installing the Amazon GuardDuty app" heading casing with the
other section headings.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

---------

Co-authored-by: Amee Lepcha <amee.lepcha.ctr@sumologic.com>
Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* CSOAR-5161:date changed

* CSOAR-5161:deprecated description added

---------

Co-authored-by: Sachin Magar <159125519+sachin-sumologic@users.noreply.github.com>
Co-authored-by: Amee Lepcha <amee.lepcha.ctr@sumologic.com>
Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-authored-by: Kim <56411016+kimsauce@users.noreply.github.com>
Co-authored-by: Vincent Falconi (at Sumo Logic) <88168949+vfalconisumo@users.noreply.github.com>
Co-authored-by: Parth Langalia <155425340+parth-sumo@users.noreply.github.com>
Co-authored-by: Apoorv A Kudesia <apoorv.kudesia@sumologic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cla-signed Contributor approved, listed in .clabot file

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants