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

feat: add deeplinks to our documentation #1870

Merged
merged 2 commits into from
Mar 20, 2023

Conversation

blakef
Copy link
Contributor

@blakef blakef commented Mar 10, 2023

Summary:

Everything is in, so this should be good to tests against.
These changes will only start to work once our documentation is updated to support this feature:

The outcome is that we now write links like this:

import {findProjectRoot, logger, link} from '@react-native-community/cli-tools';
link.docs('environment-setup', 'ruby');

And get links this:

https://reactnative.dev/docs/environment-setup#ruby?platform=ios&os=macos

For more complicated examples you'd write this:

link.setVersion('0.69');
link.docs('environment-setup', {hash:'ruby', platform: 'ios', guide: 'native', very: 'extensible'})

https://reactnative.dev/docs/0.69/environment-setup#ruby?platform=ios&os=macos&guide=native&very=extensible

Depending on how the user has run the project. With this result if clicked on:

CleanShot 2023-03-10 at 18 49 43

Test Plan:

I've run this against a locally generated project from init. I'll do something more comprehensive, but wanted to get some direction feedback before.

@blakef blakef force-pushed the feat-deeplink-support branch 2 times, most recently from 876d96b to 36d0f5e Compare March 16, 2023 13:28
@blakef blakef marked this pull request as ready for review March 16, 2023 14:30
Copy link
Collaborator

@adamTrz adamTrz left a comment

Choose a reason for hiding this comment

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

Massive work, thanks for the PR! 🎉

packages/cli-config/src/loadConfig.ts Show resolved Hide resolved
@blakef blakef requested review from adamTrz and removed request for thymikee March 17, 2023 16:43
@blakef blakef force-pushed the feat-deeplink-support branch 2 times, most recently from b98efe0 to f70caa5 Compare March 17, 2023 22:16
@adamTrz
Copy link
Collaborator

adamTrz commented Mar 20, 2023

@blakef Mind resolving conflicts so we can merge? 🙏

These changes will only start to work once our documentation is updated
to support this feature:
- facebook/react-native-website#3618
- facebook/react-native-website#3619
- facebook/react-native-website#3620
There was a single version check that would log an available stable
version of React Native that was greater than the current version in a
project.

The change breaks that up into:
- what is the current version
- what is the next stable upgrade if available
- log any stable upgrade if available
@blakef
Copy link
Contributor Author

blakef commented Mar 20, 2023

@adamTrz thanks for all of your support on this PR. Fixed the conflict.

@adamTrz adamTrz merged commit e230187 into react-native-community:main Mar 20, 2023
@blakef blakef deleted the feat-deeplink-support branch March 20, 2023 11:25
@thymikee
Copy link
Member

This is the feature I've been waiting for years :D Thank you @blakef

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants