Skip to content

docs: add mdx file linting, fixup all mdx-related errors#8993

Merged
mikehardy merged 3 commits into
mainfrom
@mikehardy/more-docs-tweaks
Apr 23, 2026
Merged

docs: add mdx file linting, fixup all mdx-related errors#8993
mikehardy merged 3 commits into
mainfrom
@mikehardy/more-docs-tweaks

Conversation

@mikehardy

@mikehardy mikehardy commented Apr 23, 2026

Copy link
Copy Markdown
Collaborator

Description

There were some problems in the conversion from previous Gatsby static website build and dynamic docs.page mdx build - specifically some of the files had invalid MDX

This PR adds an MDX linter to our eslint config, and configures our lint:markdown run target to use it, then fixes all errors that turned up

An unfortunate discovery was that when I previously converted our eslint config file from the legacy format to the new "flat config" format I did so in a compatibility mode that was a real hash - I paid up the technical debt and forward-ported us to a really clean eslint "flat config" style in the first commit so that I could add the mdx file easily

Related issues

Release Summary

docs only, will go live once merged to main

Checklist

  • I read the Contributor Guide and followed the process outlined there for submitting PRs.
    • Yes
  • My change supports the following platforms;
    • Android
    • iOS
    • Other (macOS, web)
  • My change includes tests;
    • e2e tests added or updated in packages/\*\*/e2e
    • jest tests added or updated in packages/\*\*/__tests__
  • I have updated TypeScript types that are affected by my change.
  • This is a breaking change;
    • Yes
    • No

Test Plan

1- hit rnfirebase.io/messaging/usage and it should work (can check the preview link as well, and should work --> https://rnfirebase.io/~8993/messaging/usage )
2- yarn lint:markdown should also pass, and will be exercised in CI (or when tested locally) to make sure nothing creeps in over time without us knowing


Think react-native-firebase is great? Please consider supporting the project with any of the below:

previously it was working in compability mode and the config was a mess
of technical debt, now the config is squeaky clean and ready for future additions
@vercel

vercel Bot commented Apr 23, 2026

Copy link
Copy Markdown

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

Project Deployment Actions Updated (UTC)
react-native-firebase Error Error Apr 23, 2026 0:30am

Request Review

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Code Review

This pull request adds an 'AI Logic' group to the documentation, updates versioning language in MDX files, and migrates the ESLint configuration to the Flat Config format. Feedback focuses on correcting the ESLint configuration, where the extends key is invalid and configs.all was unintentionally enabled. Additionally, logical errors were identified in the Android and iOS installation guides regarding manual integration requirements, and the markdown linting glob was found to be too restrictive, potentially excluding standard .md files.

Comment thread eslint.config.mjs
Comment thread eslint.config.mjs
Comment thread docs/install-android.mdx
Comment thread docs/install-ios.mdx
Comment thread package.json
@mikehardy mikehardy force-pushed the @mikehardy/more-docs-tweaks branch from b7f4f4c to b71dc39 Compare April 23, 2026 12:28
@mikehardy mikehardy merged commit a6829ae into main Apr 23, 2026
16 of 17 checks passed
@mikehardy mikehardy deleted the @mikehardy/more-docs-tweaks branch April 23, 2026 12:29
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.

[📚] Cloud Messaging document can't be opened

2 participants