Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ This file is the canonical source of context and guardrails for AI coding agents
Open-source Sumo Logic documentation site built with Docusaurus 3.
Docs live in /docs, written in Markdown. Contributions follow the Sumo Logic style guide.

This repo takes contributions from both Sumo Logic employees and external community contributors (see [docs/contributing](https://www.sumologic.com/help/docs/contributing) for the fork-and-PR workflow external contributors follow). Most of this file — the skills, directory conventions, frontmatter rules, and slash commands below — works the same for anyone with the repo cloned and Claude Code installed. The exception is anything under **Jira Rules** and the Jira-specific steps in **Pull Requests**: those require internal Sumo Logic Atlassian access, so external contributors should skip them and follow the plain PR steps in docs/contributing instead.

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

Expand Down Expand Up @@ -83,8 +85,8 @@ Before pushing any commit that changes docs content:
2. Tell the user to confirm the changes appear correctly on the site
3. Wait for explicit approval before pushing

## Jira Rules
**CRITICAL**: All Jira operations MUST follow the patterns defined in `.claude/commands/jira.md`.
## Jira Rules (Sumo Logic internal — requires Atlassian access)
**CRITICAL**: All Jira operations MUST follow the patterns defined in `.claude/commands/jira.md`. This section applies to Sumo Logic employees only — external contributors don't have access to the internal Jira instance and should skip it.

### Field Requirements
- **Assignee**: Do not set manually — Jira Automation assigns based on Technical Area.
Expand Down Expand Up @@ -130,8 +132,8 @@ If you change the `/help/llm/` URL structure or add new machine-readable mirror

The sections below apply only to Claude Code. Other agents can ignore them.

### Jira Commands
All Jira operations MUST follow the patterns defined in `.claude/commands/jira.md`, including the three-approach ticket-creation pattern and Technical Area mappings.
### Jira Commands (Sumo Logic internal)
All Jira operations MUST follow the patterns defined in `.claude/commands/jira.md`, including the three-approach ticket-creation pattern and Technical Area mappings. Requires internal Atlassian access — not available to external contributors.

### Slash Commands
Primary commands for documentation work. Proactively suggest when context fits — don't wait for the user to ask.
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,9 +69,9 @@ Any broken links or images will be listed in the output. Fix them, rebuild, and
| `docusaurus.config.ts` | Site configuration |
| `cid-redirects.json` | Permanent URL redirects (CID mappings) |

## For Docs Team contributors
## Claude Code tooling

This repo includes [Claude Code](https://claude.ai/code) tooling for the Docs Team — slash commands for creating docs, auditing content, managing Jira tickets, and more. See [CLAUDE.md](CLAUDE.md) for the full reference.
This repo includes [Claude Code](https://claude.ai/code) slash commands for creating docs, auditing content, and more. Most commands work for anyone with the repo cloned, including external contributors — the exception is Jira-related commands, which require internal Sumo Logic Atlassian access and are for the Docs Team only. See [AGENTS.md](AGENTS.md) for the full reference.

## Publishing

Expand Down
5 changes: 5 additions & 0 deletions docs/contributing/create-edit-doc.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,11 @@ import DocPrereq from '../reuse/doc-prerequisites.md';

<DocPrereq/>

:::tip Using Claude Code (optional)
This repository includes [Claude Code](https://claude.ai/code) slash commands (in `.claude/commands/`) that can help you draft and review docs locally — for example, `/doc` to scaffold a new doc, or `/audit-doc` and `/seo-audit` to review one before opening a PR. If you have Claude Code installed, these work the same way against your fork. See [AGENTS.md](https://github.com/SumoLogic/sumologic-documentation/blob/main/AGENTS.md) for the full list.

A few commands (`/jira`, `/doc-from-jira`) require internal Sumo Logic Jira access and aren't available to external contributors — follow the steps below instead.
:::

## Quickstart

Expand Down
4 changes: 4 additions & 0 deletions docs/contributing/remove-doc.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@ import DocPrereq from '../reuse/doc-prerequisites.md';

<DocPrereq/>

:::tip Using Claude Code (optional)
This repository includes a [Claude Code](https://claude.ai/code) `/remove-doc` slash command (in `.claude/commands/`) that automates the steps below — creating the redirect, updating internal links, and removing the doc from navigation. If you have Claude Code installed, it works the same way against your fork. See [AGENTS.md](https://github.com/SumoLogic/sumologic-documentation/blob/main/AGENTS.md) for details.
:::

## Step 1: Create a 301 redirect

As an example, let's say there are two docs called **Nginx App** and **Nginx (Legacy) App**, and we need to deprecate the latter.
Expand Down
4 changes: 4 additions & 0 deletions docs/contributing/style-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,10 @@ To create a new doc quickly, use a template. You can copy and paste the file, ad
* [Partner app template](/docs/contributing/templates/partner-app-doc)
:::

:::tip Using Claude Code (optional)
If you have [Claude Code](https://claude.ai/code) installed, this repo's `sumo-style` skill automatically applies the conventions on this page when you draft or edit docs — you don't need to invoke it manually. See [AGENTS.md](https://github.com/SumoLogic/sumologic-documentation/blob/main/AGENTS.md) for details.
:::

## Voice and tone

* **Clarity and professionalism**. We are clear, genuine, and trustworthy. We understand that our customers entrust us with their vital data and never make light about our commitment to data access and security.
Expand Down