Skip to content

Conversation

CaptainWang98
Copy link
Contributor

Description

A render error shows up in docs here in preview mode.

In Mermaid flowcharts, when node labels contain special characters (such as brackets, Unicode characters, etc.), you should use double quotes to surround the text instead of using the special characters directly within the square brackets.

reference: https://mermaid.js.org/syntax/flowchart.html#special-characters-that-break-syntax

### Runtime Convenience Layer
```mermaid
flowchart LR
subgraph "Runtime Package"
GlobalAPI[Global API Functions]
InstanceManager[Instance Manager]
BuildIntegration[Build Integration]
end
subgraph "Core APIs"
LoadRemote[loadRemote()]
LoadShare[loadShare()]
Init[init()]
RegisterRemotes[registerRemotes()]
end
GlobalAPI --> LoadRemote
GlobalAPI --> LoadShare
GlobalAPI --> Init
GlobalAPI --> RegisterRemotes
InstanceManager --> GlobalAPI
BuildIntegration --> InstanceManager
```

image

Related Issue

Types of changes

  • Docs change / refactoring / dependency upgrade
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)

Checklist

  • I have added tests to cover my changes.
  • All new and existing tests passed.
  • I have updated the documentation.

Copy link

changeset-bot bot commented Sep 30, 2025

⚠️ No Changeset found

Latest commit: 6693943

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

netlify bot commented Sep 30, 2025

Deploy Preview for module-federation-docs ready!

Name Link
🔨 Latest commit 6693943
🔍 Latest deploy log https://app.netlify.com/projects/module-federation-docs/deploys/68db96deff6b440009318702
😎 Deploy Preview https://deploy-preview-4108--module-federation-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@ScriptedAlchemy ScriptedAlchemy merged commit f0c1e79 into module-federation:main Sep 30, 2025
5 checks passed
@2heal1 2heal1 mentioned this pull request Oct 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants