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.

Sign up for GitHub

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

Jump to bottom

Add documentation for DevSettingsModule #1523

Closed
rickhanlonii opened this issue Dec 26, 2019 · 10 comments
Closed

Add documentation for DevSettingsModule #1523

rickhanlonii opened this issue Dec 26, 2019 · 10 comments

Comments

@rickhanlonii
Copy link
Member

In facebook/react-native#25848 we added a new method to DevSettings addMenuItem which allows users to add additional dev menu options to their app.

This module was previously undocumented because it was mostly only used internally.

Now that there's a method users may use, we should document it.
@rickhanlonii rickhanlonii mentioned this issue Dec 26, 2019
Closed
@mohamedsgap
Copy link
Contributor

Can I write a doc for it ?

@rickhanlonii
Copy link
Member Author

Yeah that would be awesome!

@mohamedsgap
Copy link
Contributor

it sounds good, I gonna work on it and I'll make my PR asap!

@mohamedsgap
Copy link
Contributor

@rickhanlonii Where should I write the doc ? in settings.md!!

@rickhanlonii
Copy link
Member Author

@mohamedsgap I would add it as an API reference like https://facebook.github.io/react-native/docs/clipboard

@mohamedsgap
Copy link
Contributor

Hey @rickhanlonii just need you to review DevSettings API reference #1539 to see if i wrote it correctly or need some changes!

@mohamedsgap mohamedsgap mentioned this issue Feb 3, 2020
Merged
rachelnabors pushed a commit that referenced this issue Feb 7, 2020
@mohamedsgap @rickhanlonii
[DOC]: API Reference for DevSettings.addMenuItem() #1523 (#1539)
c54779d 
* started doc addMenuItem

* added API reference DevSettings

* Update DevSettings API reference

* Update docs/devsettings.md

Co-Authored-By: Ricky <[email protected]>

Co-authored-by: Ricky <[email protected]>
espipj pushed a commit to espipj/react-native-website that referenced this issue Feb 8, 2020
@mohamedsgap @rickhanlonii @espipj
[DOC]: API Reference for DevSettings.addMenuItem() facebook#1523 (fac…
6562436 
…ebook#1539)

* started doc addMenuItem

* added API reference DevSettings

* Update DevSettings API reference

* Update docs/devsettings.md

Co-Authored-By: Ricky <[email protected]>

Co-authored-by: Ricky <[email protected]>
@estevaolucas
Copy link

@rickhanlonii can we add a reference for reload method as well? https://github.com/facebook/react-native/pull/25848/files#diff-bd79be22516654291770eb407afd366fR33-R35

kaioduarte pushed a commit to kaioduarte/react-native-website that referenced this issue Feb 24, 2020
@mohamedsgap @rickhanlonii @kaioduarte
[DOC]: API Reference for DevSettings.addMenuItem() facebook#1523 (fac…
a482fb3 
…ebook#1539)

* started doc addMenuItem

* added API reference DevSettings

* Update DevSettings API reference

* Update docs/devsettings.md

Co-Authored-By: Ricky <[email protected]>

Co-authored-by: Ricky <[email protected]>
@Simek Simek mentioned this issue Mar 10, 2020
Merged
@rachelnabors
Copy link
Contributor

Looks like the docs are baked! Thank you, all!

@rickhanlonii
Copy link
Member Author

@estevaolucas yeah feel free to submit a PR!

@estevaolucas
Copy link

@rickhanlonii it's already fixed. @Simek already added the reference for `reload method here #1722. Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@rachelnabors @rickhanlonii @estevaolucas @mohamedsgap