DOCS-1609 - Update README with tech stack badges, repo structure, claude

README.md

@@ -1,81 +1,89 @@
-<img src="https://www.sumologic.com/help/img/reuse/sumo-docs-readme.png" width="400"/>
+# Sumo Docs
 
-<p>
-  <a href="https://github.com/SumoLogic/sumologic-documentation/blob/main/.github/workflows/production.yml"><img src="https://github.com/SumoLogic/sumologic-documentation/actions/workflows/production.yml/badge.svg" alt="GitHub Actions status"></a>
-  <a href="https://www.sumologic.com/help/docs/contributing"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg" alt="PRs Welcome"></a>
-  <a href="LICENSE"><img src="https://img.shields.io/github/license/sourcerer-io/hall-of-fame.svg?colorB=ff0000"></a>
-  <a href="https://x.com/SumoLogic"><img src="https://img.shields.io/twitter/follow/sumologic.svg?style=social" alt="Twitter Follow" /></a>
-  <a href="https://www.sumologic.com/help/release-notes-service"><img src="https://img.shields.io/badge/RSS-FFA500?style=for-the-badge&logo=rss&logoColor=white" alt="RSS Follow" width="50"/></a>
-</p>
+[![Build](https://img.shields.io/github/actions/workflow/status/SumoLogic/sumologic-documentation/workflow_deploy-to-pantheon-prod.yml?style=flat&label=build)](https://github.com/SumoLogic/sumologic-documentation/actions/workflows/workflow_deploy-to-pantheon-prod.yml)
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat)](https://www.sumologic.com/help/docs/contributing)
+[![License](https://img.shields.io/github/license/sourcerer-io/hall-of-fame.svg?style=flat&colorB=ff0000)](LICENSE)
+[![Twitter Follow](https://img.shields.io/twitter/follow/sumologic.svg?style=social)](https://x.com/SumoLogic)
+[![RSS](https://img.shields.io/badge/RSS-FFA500?style=flat&logo=rss&logoColor=white)](https://www.sumologic.com/help/docs/release-notes/#subscribe-via-rss)
 
-Sumo Docs is the open-source documentation site for Sumo Logic, an all-in-one cloud data analytics platform built to support security, operations, and business intelligence use cases. Sumo Logic empowers users to monitor, analyze, troubleshoot, and visualize data from their applications and network environments in real time. Its elastic processing capabilities enable seamless log data collection and management from various sources, regardless of type, volume, or location. Learn more at [sumologic.com](https://www.sumologic.com).
+[![Docusaurus](https://img.shields.io/badge/Docusaurus-3ECC5F?style=flat&logo=docusaurus&logoColor=white)](https://docusaurus.io)
+[![React](https://img.shields.io/badge/React-20232A?style=flat&logo=react&logoColor=61DAFB)](https://react.dev)
+[![TypeScript](https://img.shields.io/badge/TypeScript-007ACC?style=flat&logo=typescript&logoColor=white)](https://www.typescriptlang.org)
+[![Node.js](https://img.shields.io/badge/Node.js-339933?style=flat&logo=nodedotjs&logoColor=white)](https://nodejs.org)
+[![GitHub Actions](https://img.shields.io/badge/GitHub_Actions-2088FF?style=flat&logo=githubactions&logoColor=white)](https://github.com/features/actions)
+[![Algolia](https://img.shields.io/badge/Algolia-003DFF?style=flat&logo=algolia&logoColor=white)](https://www.algolia.com)
+[![Pantheon](https://img.shields.io/badge/Pantheon-FFDC28?style=flat&logo=pantheon&logoColor=black)](https://pantheon.io)
 
-## Get involved
-
-We welcome contributions from the community! Whether it's fixing a typo, adding new content, or proposing improvements, your input helps users make the most of Sumo Logic. You can contribute by creating an issue or submitting a pull request in our GitHub repository.
+Sumo Docs is the open-source documentation site for Sumo Logic, an AI-powered security operations platform providing Cloud SIEM and security analytics to help teams automate, detect, and investigate threats. Sumo Logic empowers users to monitor, troubleshoot, and defend their environments using AI insights powered by log analytics. Learn more at [sumologic.com](https://www.sumologic.com).
 
-Here’s how to get started:
-- Fork our repo and create a new branch for your content changes.
-- Preview your edits by building the site locally.
-- Submit a pull request for review.
+The site is built with [Docusaurus 3](https://docusaurus.io/) and supports React, Rehype, and Remark plugins.
 
-Our team will help review, test, and merge your contributions for publishing.
-
-Sumo Docs is built with [Docusaurus 3](https://docusaurus.io/) and supports React, Rehype, and Remark plugins. We also use [cla-bot](https://colineberhardt.github.io/cla-bot/) to manage our Contributor License Agreement (CLA) process.
+## Get involved
 
-Before submitting an issue or pull request, we recommend reviewing the sections below.
+We welcome contributions from the community. You can fix a typo, propose new content, or improve existing docs by [opening an issue](https://github.com/SumoLogic/sumologic-documentation/issues/new/choose) or submitting a pull request.
 
-## Table of contents
+Browse [existing issues](https://github.com/SumoLogic/sumologic-documentation/issues) before opening a new one — someone may have already reported it.
 
-- [Get involved](#get-involved)
-- [Prerequisites](#prerequisites)
-- [Installation](#installation)
-- [Contributing content](#contributing-content)
-- [Building locally](#building-locally)
-- [Publishing content](#publishing-content)
+We use [cla-bot](https://colineberhardt.github.io/cla-bot/) to manage our Contributor License Agreement (CLA) process. You will be prompted to sign the CLA on your first contribution.
 
 ## Prerequisites
 
-To contribute to Sumo Docs, ensure you have the following tools installed:
-
 - [Node.js](https://nodejs.org/en/download/) version 20 or higher
 - [Yarn](https://yarnpkg.com/en/), installable via [Homebrew](https://brew.sh/) (`brew install yarn`)
 
 ## Installation
 
-1. Fork and clone the repository using Git or a tool like GitHub Desktop.
-2. Navigate to the cloned repository folder:
+1. Fork and clone the repo.
+1. Navigate to the repo folder:
+
    ```bash
    cd sumologic-documentation
    ```
-3. Install dependencies:
+
+1. Install dependencies:
+
    ```bash
    yarn install
    ```
 
 ## Apply your changes
 
-Make edits using [Markdown syntax](https://www.sumologic.com/help/docs/contributing/style-guide/#markdown). Keep contributions concise, informative, and aligned with our guidelines.
+Edit files using [Markdown syntax](https://www.sumologic.com/help/docs/contributing/style-guide/#markdown). Keep contributions concise, accurate, and aligned with our [Style Guide](https://www.sumologic.com/help/docs/contributing/style-guide/).
 
-Refer to our [Contributor Guidelines](https://www.sumologic.com/help/docs/contributing/create-edit-doc/#edit-a-doc) for more information on:
-- Markdown editing
-- Proposing bug fixes
-- Testing your changes
+See our [Contributor Guidelines](https://www.sumologic.com/help/docs/contributing/create-edit-doc/#edit-a-doc) for details on Markdown editing, proposing bug fixes, and testing your changes.
 
-All contributions must follow our [Style Guide](https://www.sumologic.com/help/docs/contributing/style-guide/).
+## Build locally
 
-## Building locally
+Serve and preview your changes with hot reloads:
 
-Building the site locally ensures your changes are accurate and functional before submission.
+```bash
+yarn start
+```
 
-Serve and preview your content with hot reloads:
-   ```bash
-   yarn start
-   ```
-   Any issues, such as broken links or images, will be listed. Fix them, rebuild, and verify your changes.
+Any broken links or images will be listed in the output. Fix them, rebuild, and verify before submitting. Press `Ctrl + C` to stop the local server.
+
+## Repo structure
+
+| Path | Contents |
+|------|----------|
+| `/docs` | Documentation source files |
+| `/blog-service` | Service release notes |
+| `/blog-collector` | Collector release notes |
+| `/blog-cse` | Cloud SIEM release notes |
+| `/blog-csoar` | Cloud SOAR release notes |
+| `/static/img` | Images and media assets |
+| `sidebars.ts` | Left-nav sidebar configuration |
+| `docusaurus.config.ts` | Site configuration |
+| `cid-redirects.json` | Permanent URL redirects (CID mappings) |
+
+## For Docs Team contributors
+
+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.
+
+## Publishing
 
-To stop the local server process, press `Ctrl + C`. You can restart as needed.
+Our docs team reviews issues and pull requests regularly. We will help review, test, and merge your contributions for publishing. Response times may vary depending on the backlog.
 
-## Publishing content
+## License
 
-Our documentation team regularly reviews issues and pull requests. While we strive to address contributions promptly, there may be delays as we work through the backlog. Your patience is appreciated.
+This project is licensed under the [Apache 2.0 License](LICENSE).