Skip to content

hotfix: fix oom build issue#3010

Draft
manika-signoz wants to merge 23 commits intomainfrom
fix/build-oom
Draft

hotfix: fix oom build issue#3010
manika-signoz wants to merge 23 commits intomainfrom
fix/build-oom

Conversation

@manika-signoz
Copy link
Copy Markdown
Contributor

@manika-signoz manika-signoz commented Apr 2, 2026

Summary

Removes the KeyPointCallout MDX component and replaces all usages with Admonition, which was already the underlying implementation. Updates MDX component registration, agent markdown stubs, and related tests.

Motivation / Problem

Large Next.js builds were hitting memory limits (OOM). KeyPointCallout was a thin wrapper around Admonition that added an extra MDX component surface across many pages. Consolidating on Admonition directly reduces redundant component handling during the build.

Changes

  • Remove KeyPointCallout from components/MDXComponents.tsx (previously delegated to Admonition).
  • Replace <KeyPointCallout …> / </KeyPointCallout> with <Admonition …> / </Admonition> across blog, docs, comparisons, guides, and OpenTelemetry content MDX files.
  • Drop KeyPointCallout from KNOWN_AGENT_MDX_COMPONENT_NAMES and remove its stub in utils/docs/agentMarkdownStubs.ts.
  • Remove tests that targeted KeyPointCallout-specific stub and copy-markdown behavior in tests/agent-markdown-stubs.test.js and tests/markdown-core.test.js.

Description

This PR eliminates the KeyPointCallout abstraction so callouts use Admonition in sources and at build time, which should lower memory pressure during production builds while keeping the same on-page UI.

Type of Change

  • Docs – Changes to data/docs/**
  • Blog – Changes to data/blog/**
  • Site Code – Changes to app/**, components/**, hooks/**, utils/**, config, etc.
  • Redirects – Renamed/moved docs or updated next.config.js redirects
  • Dependencies / CI / Scripts
  • Other – Explain below

Impact

  • Documentation only
  • UI changes
  • Developer workflow
  • Performance impact
  • Breaking change

If breaking change, describe migration steps:

Content authors should use <Admonition> instead of <KeyPointCallout>; there is no public API change for site visitors.

Context & Screenshots

No visual change intended: KeyPointCallout rendered as Admonition before.

Before / After (if applicable)

Before: MDX used <KeyPointCallout title="…"> which mapped to <Admonition> in MDXComponents.

After: MDX uses <Admonition title="…"> directly; fewer registered MDX components and no duplicate stub path for agent markdown.

Checklist

General

  • Branch is up to date with main
  • PR title follows conventional format (type: description)
  • Self-reviewed the code
  • Comments added for complex logic

For all changes

  • Built locally (yarn build) with no errors
  • Ran yarn lint and fixed any issues
  • Pre-commit hooks passed (or ran yarn check:doc-redirects / yarn check:docs-metadata if applicable)

For docs changes (data/docs/**)

  • Followed the docs author checklist in contributing/docs-authoring.md
  • Added/updated the page in constants/docsSideNav.ts if adding or moving a doc
  • Any added docs images use WebP format and live under public/img/docs/<topic>/

For blog changes

  • Followed the blog workflow in contributing/blog-workflow.md
  • Frontmatter includes title, date, author, tags (and canonicalUrl if applicable)
  • Images use WebP format and live under public/img/blog/<YYYY-MM>/

For site code changes

For renamed or moved docs

  • Followed the redirects and discovery section in contributing/docs-authoring.md
  • Added permanent redirect in next.config.js under async redirects()
  • Updated internal links and sidebar in constants/docsSideNav.ts
  • Ran yarn check:doc-redirects to verify

Testing

  • Tested locally
  • Edge cases considered
  • Existing functionality verified
  • New tests added (if applicable)

Steps to test:

  1. Run yarn build and confirm the build completes without OOM (compare to main if needed).
  2. Spot-check a few docs and blog pages that used KeyPointCallout and confirm callouts still look correct (collapsed/expanded behavior where defaultCollapsed was used).
  3. Run yarn test (or the relevant test subset for agent markdown / markdown core) and ensure nothing regresses.

Note: Submit as Draft by default. Mark "Ready for review" when checks pass and content is ready.

@vercel
Copy link
Copy Markdown

vercel bot commented Apr 2, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
signoz-web Ready Ready Preview, Comment Apr 2, 2026 0:48am

Request Review

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 2, 2026

CMS Sync Successful

Content has been synced to Strapi CMS with deployment status: staging

📊 Summary

Operation Count
✅ Created 0
🔄 Updated 10
🗑️ Deleted 0
⏭️ Skipped 156

🔗 Relations

The following relations were automatically resolved:

  • authors
  • tags
  • related_comparisons
  • related_blogs
  • keywords

📄 Processed Documents

View 10 document(s)
Operation Route
Updated /appdynamics-vs-splunk
Updated /aws-monitoring-tools
Updated /better-stack-alternatives
Updated /graylog-vs-loki
Updated /graylog-vs-splunk
Updated /logicmonitor-competitors
Updated /opentelemetry-vs-tempo
Updated /go
Updated /nodejs
Updated /python

⚠️ Relation Warnings

Some relations could not be resolved due to missing or unmatched fields:

View 1 warning(s)

File: /aws-monitoring-tools

  • authors: 1 unmatched value(s)
    • sarafadeen_ibrahim

Note: Documents were still synced successfully, but some relations were omitted. Please check the values in your frontmatter.

@manika-signoz manika-signoz changed the title test hotfix: fix oom build issue Apr 2, 2026
@manika-signoz manika-signoz marked this pull request as ready for review April 2, 2026 07:03
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 2, 2026

Claude finished @manika-signoz's task in 1m 33s —— View job


PR Review: hotfix: fix oom build issue

  • Gather context and read changed files
  • Verify component compatibility (Admonition supports defaultCollapsed)
  • Check for stale KeyPointCallout references
  • Review code changes (MDXComponents, agent stubs, tests)
  • Post review summary

Summary

The mechanical replacement of KeyPointCalloutAdmonition across 170 files is correct. Admonition already accepts defaultCollapsed, title, and type props, so all existing callout behavior is preserved. The MDXComponents.tsx removal, agent stub cleanup, and test deletions are consistent.

Issues

Stale references to KeyPointCallout in contributing docs (not updated in this PR):

These files still tell authors/agents to use the removed component:

File Line Issue
contributing/docs-authoring.md 119 Guidance says "Use KeyPointCallout for supplementary or optional material" — should reference Admonition instead
contributing/templates/send-data-doc.md 11–15 Template uses <KeyPointCallout> — new docs from this template would reference a removed component
contributing/docs-review.md 191 rg pattern still searches for KeyPointCallout — should be removed or replaced
.agents/skills/signoz-docs-pr-review/SKILL.md 85 Same stale rg pattern

These should be updated in this PR to avoid confusing future contributors who follow the authoring guide or use the template.

Fix stale contributing references →

Checklist items from PR description

  • The PR description checklist items are mostly unchecked. In particular: "Branch is up to date with main", "Built locally (yarn build) with no errors", and "Ran yarn lint" should be confirmed before merge.
  • The Vercel preview deployed successfully, which is a good signal.

Verdict

The core change is sound — straightforward find-and-replace with no semantic difference. The one actionable gap is the stale contributing docs/templates listed above, which should be fixed to keep the authoring guide consistent with the codebase.

--- | Branch: fix/build-oom

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 2, 2026

CMS Sync Successful

Content has been synced to Strapi CMS with deployment status: staging

📊 Summary

Operation Count
✅ Created 0
🔄 Updated 10
🗑️ Deleted 0
⏭️ Skipped 156

🔗 Relations

The following relations were automatically resolved:

  • authors
  • tags
  • related_comparisons
  • related_blogs
  • keywords

📄 Processed Documents

View 10 document(s)
Operation Route
Updated /appdynamics-vs-splunk
Updated /aws-monitoring-tools
Updated /better-stack-alternatives
Updated /graylog-vs-loki
Updated /graylog-vs-splunk
Updated /logicmonitor-competitors
Updated /opentelemetry-vs-tempo
Updated /go
Updated /nodejs
Updated /python

⚠️ Relation Warnings

Some relations could not be resolved due to missing or unmatched fields:

View 1 warning(s)

File: /aws-monitoring-tools

  • authors: 1 unmatched value(s)
    • sarafadeen_ibrahim

Note: Documents were still synced successfully, but some relations were omitted. Please check the values in your frontmatter.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 2, 2026

CMS Sync Successful

Content has been synced to Strapi CMS with deployment status: staging

📊 Summary

Operation Count
✅ Created 0
🔄 Updated 10
🗑️ Deleted 0
⏭️ Skipped 156

🔗 Relations

The following relations were automatically resolved:

  • authors
  • tags
  • related_comparisons
  • related_blogs
  • keywords

📄 Processed Documents

View 10 document(s)
Operation Route
Updated /appdynamics-vs-splunk
Updated /aws-monitoring-tools
Updated /better-stack-alternatives
Updated /graylog-vs-loki
Updated /graylog-vs-splunk
Updated /logicmonitor-competitors
Updated /opentelemetry-vs-tempo
Updated /go
Updated /nodejs
Updated /python

⚠️ Relation Warnings

Some relations could not be resolved due to missing or unmatched fields:

View 1 warning(s)

File: /aws-monitoring-tools

  • authors: 1 unmatched value(s)
    • sarafadeen_ibrahim

Note: Documents were still synced successfully, but some relations were omitted. Please check the values in your frontmatter.

This reverts commit 2579407.
This reverts commit 9d86ab2.
This reverts commit e2cd73b.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants