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

Add more linking documentation #419

Conversation

Tvrqvoise
Copy link

Goals

  • Add documentation for rnpm
  • Move react-native link's documentation out of the "Platform Specific (iOS)" section since it applies to both platforms

Concerns

  • I don't document rnpm's "commands" or "plugins" fields. Namely because I don't use them and don't feel sufficiently knowledgeable about them to write technical documentation. That being said, rnpm is totally undocumented today, so this still seems like an improvement to me.

…fic iOS linking documentation, add documentation for rnpm
@react-native-bot

This comment has been minimized.

@react-native-bot
Copy link

Deploy preview for react-native ready!

Built with commit fc21b81

https://deploy-preview-419--react-native.netlify.com

Changes to docs/ are reflected in the next "master" version.

Thank you for your contributions.

How to ContributeDocumentation Sources

@hramos
Copy link
Contributor

hramos commented Jun 26, 2018

Thanks for this! I think there's an opportunity to move this to a single guide that is not specific to iOS or Android. As it stands now, the PR results in two similarly named guides: "Linking Libraries", and "Linking Libraries (iOS)". The "(iOS)" portion of the title of this second guide is redundant, as the guide already appears under the "Guides (iOS)" section.

This can be worked around by having a singular "Linking Libraries" document that covers both iOS and Android (it's OK to link to Native Modules for more information for Android developers), or alternatively, using different titles for each guide. I know this is not as straightforward - we have "Native Modules" and "Linking Libraries" guides that each cover related topics - so if re-working all of these docs is too much trouble, you can simply add the new documentation to the existing guide without creating a brand new one.

@Tvrqvoise
Copy link
Author

Okay, so just to clarify before I make the change: we should have a single page under "Guides" which looks like the following:

## Automatic Linking
[ Describe react-native link ]

## Packaging Assets
[ Describe the package.json rnpm.assets field ]

## Manual Linking

### iOS
[ The content which is currently under the iOS Linking Libraries document ]

### Android
[ Just a link to "Guides (Android): Native Modules" ]

Also, how would you feel about renaming this guide to "Importing Native Code" or something similar to avoid conflicts with the "Linking" API guide, which is about an unrelated topic?

@hramos
Copy link
Contributor

hramos commented Jun 28, 2018

I like that approach. Perhaps "Working with Native Code" or something along those lines for the title?

@cpojer
Copy link
Contributor

cpojer commented Feb 7, 2019

We are currently rethinking how we want native modules to be used so I'm going to go ahead and close this PR for now. Please do get involved in the discussion though: react-native-community/discussions-and-proposals#96

@cpojer cpojer closed this Feb 7, 2019
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.

4 participants