sumologic-documentation AGENTS.md

Repository instructions for Sumo Logic’s open-source documentation website, which uses Docusaurus 3 to turn Markdown files into web documentation. They describe the project layout and the rules for writing, editing, and submitting changes.

In plain words
What is it for?
Use them when editing docs, following Sumo Logic’s writing style, working with Docusaurus syntax, preparing pull requests, or applying the repository’s SEO and location-guide guidance.
Why use it?
They give coding agents the project context and contribution conventions needed to make documentation changes that fit the repository.

Instructions file for CodexOpenCode

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add instructions/sumologic/sumologic-documentation/agents-md
Clone the repo
git clone --depth 1 https://github.com/SumoLogic/sumologic-documentation

Made for: Codex, OpenCode.

Per session 3,197 This file is loaded in full into every session.
When invoked 3,197 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.03197 $0.03197
Opus 5 $0.01598 $0.01598
Sonnet 5 $0.00639 $0.00639
Haiku 4.5 $0.00320 $0.00320

Measured yesterday against content hash df7cbcfc2119, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

sumologic-documentation AGENTS.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured yesterday.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

AGENTS.md · 219 lines

How it starts

The opening of the file, as written. The whole thing — 219 lines — stays where its author put it; the contents beside it link to each section on GitHub.

AGENTS.md — sumologic-documentation

This file is the canonical source of context and guardrails for AI coding agents (Claude Code, Cursor, GitHub Copilot, Codex, etc.) working in this repository. CLAUDE.md is a one-line pointer to this file, kept only because Claude Code looks for that filename specifically.

Project Overview

Open-source Sumo Logic documentation site built with Docusaurus 3. Docs live in /docs, written in Markdown. Contributions follow the Sumo Logic style guide.

Repository

@https://github.com/SumoLogic/sumologic-documentation

Key Folders

@https://github.com/SumoLogic/sumologic-documentation/tree/main/docs

Skills

  • .claude/skills/sumo-style/SKILL.md — Sumo Logic writing conventions. Claude fetches the live style guide and applies it automatically when writing or editing docs.
  • .claude/skills/docusaurus/SKILL.md — Docusaurus 3 syntax, frontmatter templates, and sidebar config patterns.
  • .claude/skills/pr-template-guide/SKILL.md — PR template structure, formatting examples, and best practices.
  • .claude/skills/geo-guide/SKILL.md — Reference guide of GEO principles and patterns loaded as context by /geo-optimize and /seo-audit. Not an invocable command.

Doc Reviews

When reviewing any PR or doc, always check existing docs of the same type in the same directory before flagging issues. A pattern consistent with neighboring docs is not a bug — it is the established convention. Only flag it if it's a deviation from the pattern or a net-new problem introduced by the PR.

Some directories have conventions that differ significantly from standard docs. For example, docs/platform-services/automation-service/app-central/integrations/ intentionally uses description: '', omits id, opens with a logo image, and includes a ***Version / Updated*** block — all correct for that directory. When in doubt, read two or three neighboring files before forming an opinion.

Bulk Changes

For any change touching 50+ files (e.g. terminology migrations, frontmatter audits, link updates, admonition format changes), follow these rules:

Read the full file on GitHub · 219 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. yesterday First seen · 219 lines · 3,197 tokens per session scan A df7cbcfc2119

Subscribe to this mod's changes

sumologic-documentation AGENTS.md is an instructions file published in the GitHub repository SumoLogic/sumologic-documentation (42 stars, last pushed 3d ago), licensed MIT. It adds 3,197 tokens to every session, about $0.0160 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.