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] Add Router API reference #28934

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

amandeepmittal
Copy link
Member

@amandeepmittal amandeepmittal commented May 16, 2024

⚠️ WIP: This PR is a work-in-progress.

Why

This PR adds a Expo Router API doc in SDK reference.

How

By updating the some of existing hooks API references to match the current details we have on https://docs.expo.dev/router/reference/hooks/. Reference doc is only generated for unversioned doc until this PR is a WIP.

Test Plan

By running yarn build and then et gdad -p expo-router.

To see changes, run docs locally and visit: http://localhost:3002/versions/unversioned/sdk/router or see Preview: http://docs.expo.dev-pr-28934.s3-website-us-east-1.amazonaws.com/versions/unversioned/sdk/router/.

Checklist

@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 a8bd55b

@expo-bot expo-bot added the bot: suggestions ExpoBot has some suggestions label May 16, 2024
@expo-bot
Copy link
Collaborator

📘 Your docs preview website is ready!

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

2 participants