SSWConsulting / SSWConsulting/SSW.Rules

🦙 Bug - TinaCMS Dependency - BoxEmbed - Support nested MDX components

Open
#2,169 3 comments 6 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

TinaCMS v4.1 YakShaver
Dominant language
TypeScript
Stars
26
Forks
17
Avg merge
14h 39m
Merged PRs (30d)
2

Description

Requested by: @jakebayliss via YakShaver.ai 🦬
cc: @jakebayliss, @Aibono1225, @Marxoz, @PothieuG, @Freego1783

Hi Team!

  🟥  Watch the video (1 min 14 sec)

  Url from screen share: https://www.ssw.com.au/rules-beta/admin#/rules-beta/prefix-job-title

Pain

MDX components are not rendering properly when nested inside other MDX components. This issue is observed when an image is embedded inside a box component, and it fails to render correctly.

Acceptance Criteria
  1. MDX components should render correctly when nested inside other MDX components.
  2. The image embedded inside the box component should display properly.
  3. Ensure that the fix does not affect other functionalities of the application.
Reproduce Steps
  1. Navigate to the SSW rules page.
  2. Scroll down to the bottom of the page where the box component with an embedded image is located.
  3. Observe that the image does not render properly inside the box component.
  4. Check the same issue on 'Marina Gerber's side of the rule to confirm the rendering problem.
Screenshot

Screenshot
Figure: MDX components cannot be nested

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reproducing the rendering problem at the SSW rules URL and inspect the TinaCMS/MDX rendering entry point responsible for the box component. Verify the nested image case and the corresponding example on Marina Gerber's rule. Done means nested MDX components render correctly, the image displays inside the box, and other application functionality remains unaffected.

Written by the indexing model from the issue text.

Assessment

Tech stack
nextjs, typescript
Domain
frontend, web-dev
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.