Skip to content

Conversation

@leslie-lau
Copy link
Contributor

No description provided.

Copilot AI review requested due to automatic review settings November 17, 2025 19:41
@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Nov 17, 2025

Deploying devcycle-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: a5c2db7
Status: ✅  Deploy successful!
Preview URL: https://85a73291.devcycle-docs.pages.dev
Branch Preview URL: https://update-observability-best-pr.devcycle-docs.pages.dev

View logs

Copilot finished reviewing on behalf of leslie-lau November 17, 2025 19:43
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR restructures the documentation by creating a dedicated Observability section and reorganizing the best practices hierarchy. The Datadog RUM documentation is moved into the new observability subdirectory, and terminology is standardized throughout.

Key Changes:

  • Created a new "Observability" category section with a dedicated folder structure
  • Moved Datadog RUM documentation into the observability subdirectory and updated its title/metadata
  • Renumbered sidebar positions across 7 documentation files to accommodate the new organizational structure
  • Added redirect from old path to new observability path

Reviewed Changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated no comments.

Show a summary per file
File Description
docs/best-practices/observability/category.yml New category configuration file defining the Observability section at position 4 with icon and description
docs/best-practices/observability/datadog-rum.md Renamed and reorganized into observability folder; standardized terminology (Variable, Feature Flag) and added code formatting with backticks
docs/best-practices/tech-debt.md Updated sidebar position from 6 to 8 to accommodate new structure
docs/best-practices/migration.md Updated sidebar position from 6 to 7 to accommodate new structure
docs/best-practices/feature-grouping.md Updated sidebar position from 4 to 5 to accommodate new structure
docs/best-practices/effectively-organizing-feature-flags.md Updated sidebar position from 5 to 6 to accommodate new structure
docs/best-practices/continuous-deployment.md Updated sidebar position from 7 to 9 to accommodate new structure
docs/best-practices/engineering-led-experiments.md Updated sidebar position from 9 to 10 to accommodate new structure
docs/best-practices/product-led-experimentation.md Updated sidebar position from 10 to 11 to accommodate new structure
_redirects Added 301 redirect from old datadog-rum path to new observability subdirectory path
Comments suppressed due to low confidence (1)

docs/best-practices/observability/datadog-rum.md:13

  • The URL in this line contains a capitalization inconsistency. The domain should be datadoghq.com (all lowercase) rather than Datadoghq.com. URLs are case-sensitive and the canonical domain is lowercase.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@leslie-lau leslie-lau merged commit 1d6bd36 into main Nov 18, 2025
5 checks passed
@leslie-lau leslie-lau deleted the update-observability-best-practice-title branch November 18, 2025 19:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

3 participants