Documentation migration: reorganization, syntax highlighting, and brand theming#87
Merged
Documentation migration: reorganization, syntax highlighting, and brand theming#87
Conversation
## Summary - Fixed 109 broken internal links across documentation - Reorganized content into 8 logical sections - Added CI/CD workflows for link checking and PR previews - Added Docker configuration for local development - Added migration scripts for content processing ## Link Fixes - Adapter index: Fixed 5 links (defender, entra-id, gcp-pubsub, gcp-storage, gcp-logs) - Reference files: Fixed 76+ edr-events.md references - Developer guide: Fixed SDK overview paths, extension links - Extensions: Fixed using-extensions.md, binlib.md, otx.md paths - Outputs: Fixed webhook links, allowlisting path - FAQ: Fixed outputs and events references - Created missing config-hive/index.md ## Structure - 1-getting-started/: Onboarding and use cases - 2-sensors-deployment/: Endpoint agents and adapters - 3-detection-response/: D&R rules and rulesets - 4-data-queries/: LCQL, events, query console - 5-integrations/: Outputs, extensions, API integrations - 6-developer-guide/: SDKs, building extensions - 7-administration/: Access, billing, config hive - 8-reference/: Commands, events, operators, FAQ Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Changes: - Added syntax highlighting to 508 code blocks (yaml, bash, python, go, powershell, json) - Fixed incorrectly tagged code blocks (powershell -> yaml in D&R rules) - Converted markdown tables from code blocks to proper tables (lcql-examples, id-schema) - Added 106 missing pages to mkdocs.yml navigation - Removed old documentation structure (docs/limacharlie/, docs/go-sdk/, etc.) Navigation now includes: - 13 additional use cases - 15+ additional adapter types (Azure services, collaboration tools, infrastructure) - 11 additional output destinations - 14 additional extensions (Cloud CLI, Labs, more LimaCharlie and third-party) - 4 additional API integrations - Additional tutorials, troubleshooting, and reference pages Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Add clear instructions for adding, modifying, and deleting docs - Add local preview instructions - Add code block syntax highlighting examples - Document PR workflow with automated checks - Simplify structure to match new docs organization - Add quick navigation table - Document GitHub Actions workflows Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Update color palette with official brand colors from brand guide - LC Blue 1 (#0D1B2A) for headers and dark backgrounds - LC Blue 4 (#2563EB) for primary accents in light mode - LC Blue 5 (#60A5FA) for accents in dark mode - LC Pink 3 (#E91E63) for CTA buttons - Update logo to white for visibility on dark header Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
maximelb
approved these changes
Feb 4, 2026
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
2 participants
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.
Summary
Complete documentation migration and enhancement for GitHub Pages deployment:
docs/limacharlie/doc/to numbered sections (1-getting-started/,2-sensors-deployment/, etc.)Changes
Structure (255 files renamed)
docs/limacharlie/doc/*.mddocs/1-getting-started/docs/limacharlie/doc/sensors/*.mddocs/2-sensors-deployment/docs/limacharlie/doc/dr/*.mddocs/3-detection-response/New Files (31)
.github/workflows/pr-preview.yml- PR preview deployments.github/workflows/link-checker.yml- Automated link validationscripts/check-links.py,scripts/fix-internal-links.pymkdocs.ymlwith Material theme and full navigationFixes
powershell(were YAML)Brand Theme
#0D1B2A) - headers, dark backgrounds#2563EB) - primary accents (light mode)#E91E63) - CTA buttonsTest plan
mkdocs build --strict🤖 Generated with Claude Code