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
☂️ Website Redesign and Documentation Rewrite #929
Comments
Can this website be made w/ Gatsby? |
We are not considering a technical rewrite of the code. Docusauraus works fine for us at this time. |
Would love to contribute in this. |
@cpojer I'm comparing
|
|
@cpojer Do I need only create a file named
|
I got dibs on View and Text! |
@glauberfc would love to know your reasons for moving to Gatsby 😄 |
@yangshun I thought the new React site was made with Gatsby. I think this because all sites made w/ Docusaurus are very similarly and the React website is a bit more "styled" |
☂️☂️☂️☂️☂️☂️ facebook#929 ☂️☂️☂️☂️☂️☂️☂️ New APIs added: -nextFocusDown -nextFocusForward -nextFocusLeft -nextFocusUp -clickable I don't have much details on any of the `nextFocus` apis, the descriptions in the code are very vague and tell me to refer to the docs which is pretty funny because I'm adding them to the docs. Is there any easier way to figure out what new stuff has been added? I pretty much found the new APIs in the middle of View.js file, it didn't seem to have any particular order. I was hoping that new Apis would at least be at the very bottom from oldest to newest going from top to bottom.
So I made a PR for View, do my eyes deceive me or is there literally no |
I think this is 'just' updating docusaurus BTW |
Yep there's now a siteConfig option called |
@ndejesus1227 Docusaurus 2 will support MDX. Unfortunately we haven't implementing versioning and hence cannot port React Native website to Docusaurus 2. Check out https://endiliey.com/2019/05/16/docusaurus-2-technical-preview/ for a preview. |
Hi guys , i'd like to contribute , any contribution guide available and from where we should start? |
@yangshun any chance you could help us update Docusaurus so we can make the sidebar collapsible? |
I would love to contribute on this. Where should I start pl? |
|
|
I agree w/ you @ndejesus1227. I would like there is a way of import the component file and document it w/ MDX like in Docz. So, this will avoid us to copy and paste many times and will keep the docs updated. What do you think @cpojer @yangshun? Is there a way to do this w/ Docusaurus? |
Having worked with RN in it's early stages and learning from the older documentation I find this super exciting! The changes outlines here look excellent 🤘 |
@cpojer will do so! I'll also enable a bunch of other useful defaults and see if you guys like it. |
If there was something like this on Docusaurus would help a lot on the API updates. People would use a pattern to document all APIs and the JS file would be converted on a markdown file |
@glauberfc That would be possible with plugins in Docusaurus 2. I have to add a backward-compatible versioning ability to D2 before we can move RN website to D2. |
I took care of View, I can't seem to find Text.js so I'm gonna pass on that one. I'd like to call dibs on Button and FlatList! (Going for Button first) |
@ecreeth can you remove these docs via a PR? |
Of course yes! |
Would love to help! 🙌What could I do ? |
What I don't understand is how the core method of registering and running an app is not documented? AppRegistry.runApplication() has 0 documentation in https://facebook.github.io/react-native/docs/appregistry#runapplication. I Googled to find out what appParameters are supported, but actually didn't find much. Is there not a transition period where the docs are not empty? |
This sounds like a great opportunity for you to try and contribute to the docs @mikeaustin (/cc @jeremyscatigna also?) - looks like these are the params and here's the function |
@cpojer Please update the list above with the PRs that were merged. 📦 💯 To know better what we are missing |
I'm really interested in contributing to this repo. i've started working on
|
I structured and laid out the redesign of Google’s Android Fundamentals course a couple years ago. Has this issue had any attention? If not, would something of a mimic of a weather fetching app be a good fit here? Would love to start contributing to the community and could also make accompanying tutorials if I had some editing help. |
We've moved the remaining tasks into a new ticket: #1579 Please go there to help us finish up the component docs and thanks for all your help thus far! |
The content and look of the React Native website are outdated. Many of the existing guides and the overall flow of the documentation were written in 2015 and do not reflect well what it is like to build apps with React Native in 2019. When we asked what people dislike about React Native, documentation issues came up many times. We received more concrete feedback when we asked specifically.
This umbrella issue aims to outline the work necessary to update the website both with a new look and new content. While we'll handle the redesign work outside of this issue, we'd love to get your help in updating the entire documentation: if there is any item below issue that you'd love to help with, please send a Pull Request to this repo or get in touch otherwise! The best way to help right now is by updating the API docs with the actual implementations (see below) to ensure things are up-to-date for the upcoming release.
Goals
Redesign
The redesign is currently being worked on by @orta and @tesseralis. We are excited for you all to get a look very soon!
New Guide Structure
The current structure is quite outdated. It's hard to know upfront exactly what the new flow should be like but here is the proposal for a new structure which is open for discussion:
Props– Removed and rolled into basics, with links to reactjs.org.State– Removed and rolled into basics, with links to reactjs.org.Networking– Ideally we'll factor data fetching into the preceding guides, like populating a ScrollView content, for example.Documentation Rewrite Tasks
Remove the Contributing guide from the website. Move all RN development related content into the RN GitHub repo. (@hramos)Remove obsolete API docs (@cpojer)Make the high level sections in the sidebar collapsible. Update Docusaurus to 1.9.0 #934 (@yangshun)Get rid of the “Guidelines for Text (https://github.com/facebook/react-native-website/blob/master/CONTRIBUTING.md#guidelines-for-text)” (@cpojer)Minor: Remove TimerMixins from the Timer docs, it's already gone from the code.Minor: Get rid of packager/config.js stuff across the docs and recommend using the Metro file in the template.Split the website up into high-level entry points for Docs (Guides) and APIs (Components and API docs). Split up Docs and API #962 @yangshunAPI Docs
This is one where you can help even if you only have a few minutes. We need to update all our API docs and align them with the actual APIs in the code. For example, if you'd like to ensure consistency for the
ScrollView
component, it's best to go to the react-native repo and look for the ScrollView.js file. Then go through the ScrollView.md documentation in this repository and compare each prop that it accepts and update the.md
file in this repo to align with what is in the code and send a Pull Request!Guidelines
Finally, we are thinking of merging this repo back into the React Native repo to ensure API documentation will always stay up-to-date going forward. For now we'll keep using this repository for the purpose of this umbrella issue and we will attempt the merge later.
The text was updated successfully, but these errors were encountered: