Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] introduce Expo package API reference page #28945

Merged
merged 9 commits into from
May 20, 2024

Conversation

Simek
Copy link
Collaborator

@Simek Simek commented May 17, 2024

Why

So far, we have only exposed the docs for one exported method from main expo which was registerRootComponent.

Also fixes ENG-12111

How

This PR adds the page including the methods and types exported from main expo package. In the future, it should be the great place for exposing more common code shared between the packages like PermissionsResponse, Subscription or other common elements which we re-export in package code from the dependencies.

I have also removed the registerRootComponent to avoid listing the same information twice. The changes have been only applied to unversioned docs.

Test Plan

The changes have been reviewed locally. ALl lint checks and tests are passing.

Preview

screencapture-localhost-3002-versions-unversioned-sdk-expo-2024-05-17-12_06_11

@expo-bot
Copy link
Collaborator

expo-bot commented May 17, 2024

The Pull Request introduced fingerprint changes against the base commit: 9ae1cb6

Fingerprint diff
[
  {
    "type": "dir",
    "filePath": "../../node_modules/expo",
    "reasons": [
      "bareRncliAutolinking"
    ],
    "hash": "380d87060ef549a5b26c0cb313192f296230e574"
  },
  {
    "type": "dir",
    "filePath": "../../packages/expo",
    "reasons": [
      "expoAutolinkingIos",
      "expoAutolinkingAndroid",
      "expoConfigPlugins",
      "expoConfigPlugins"
    ],
    "hash": "c7873af682994bd9687e08e7ca584adf565ab983"
  },
  {
    "type": "dir",
    "filePath": "../../packages/expo-modules-core",
    "reasons": [
      "expoAutolinkingIos",
      "expoAutolinkingAndroid"
    ],
    "hash": "b6675d89e48b2a5933a3f5100a1fc35cca27204c"
  }
]

Generated by PR labeler 🤖

@expo-bot
Copy link
Collaborator

expo-bot commented May 17, 2024

📘 Your docs preview website is ready!

@Simek Simek changed the title [docs] introduce Expo package page, replace register-root-component [docs] introduce Expo package API reference page May 18, 2024
docs/pages/versions/unversioned/sdk/expo.mdx Outdated Show resolved Hide resolved
packages/expo/src/launch/registerRootComponent.tsx Outdated Show resolved Hide resolved
packages/expo/src/launch/registerRootComponent.tsx Outdated Show resolved Hide resolved
packages/expo/src/launch/registerRootComponent.tsx Outdated Show resolved Hide resolved
packages/expo-modules-core/src/reload.ts Outdated Show resolved Hide resolved
packages/expo/src/errors/ExpoErrorManager.ts Outdated Show resolved Hide resolved
docs/pages/versions/unversioned/sdk/expo.mdx Outdated Show resolved Hide resolved
docs/pages/versions/unversioned/sdk/expo.mdx Outdated Show resolved Hide resolved
docs/pages/versions/unversioned/sdk/expo.mdx Outdated Show resolved Hide resolved
Simek and others added 2 commits May 20, 2024 11:27
Co-authored-by: Aman Mittal <amandeepmittal@live.com>
Simek and others added 2 commits May 20, 2024 11:49
Co-authored-by: Aman Mittal <amandeepmittal@live.com>
@expo-bot
Copy link
Collaborator

Hi there! 👋 I'm a bot whose goal is to ensure your contributions meet our guidelines.

I've found some issues in your pull request that should be addressed (click on them for more details) 👇

⚠️ Suggestion: Missing changelog entries


Your changes should be noted in the changelog. Read Updating Changelogs guide and consider adding an appropriate entry to the following changelogs:


Generated by ExpoBot 🤖 against 633f497

Copy link

linear bot commented May 20, 2024

@Simek Simek merged commit 4ae47dc into main May 20, 2024
18 checks passed
@Simek Simek deleted the @simek/docs-add-expo-package-page branch May 20, 2024 10:27
@Kudo
Copy link
Contributor

Kudo commented May 21, 2024

that's great one. thanks for bringing this doc.

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.

None yet

5 participants