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

Onboarding for RNW is steep #4265

Closed
asklar opened this issue Mar 7, 2020 · 5 comments
Closed

Onboarding for RNW is steep #4265

asklar opened this issue Mar 7, 2020 · 5 comments
Assignees
Milestone

Comments

@asklar
Copy link
Member

asklar commented Mar 7, 2020

At the very least we need instructions (in the form of a .md file maybe), for a new person trying to build with RNW (not just building an app). Specifically: what does each folder under vNext refer to? There's Microsoft.ReactNative, ReactUWP, but there's also ReactWindowsCore...

@ghost ghost added the Needs: Triage 🔍 New issue that needs to be reviewed by the issue management team (label applied by bot) label Mar 7, 2020
@chrisglein
Copy link
Member

@jonthysell was looking into some folder restructuring, which would help make it look less confusion. There are also some documents like this one that I don't think are correctly linked into the contributing md:
https://github.com/microsoft/react-native-windows/blob/master/docs/project-structure.md
Overall the contributor documentation needs a cleanup to remove the vnext/current duplication in the docs.

Jon, assigning to you to weigh in with where you were with any restructuring you had thought out (not saying you need to do all of that here, but let us know where it is).

@chrisglein chrisglein added Documentation enhancement and removed Needs: Triage 🔍 New issue that needs to be reviewed by the issue management team (label applied by bot) bug labels Mar 9, 2020
@chrisglein chrisglein added this to the 0.62 (vNext M5) milestone Mar 9, 2020
@chrisglein chrisglein removed the vnext label Mar 18, 2020
@jonthysell
Copy link
Contributor

BTW: The new home of that file is here: https://microsoft.github.io/react-native-windows/docs/project-structure

First off, we should probably clear out the documentation here and point people toward the docs site.

For all of these docs, whether for app/module developers or framework contributors, it will need to be properly versioned, either by using branches or "archived" folders, so that we don't stomp on old docs with new changes, esp. in something like this, where we're actively refactoring project structures.

@jonthysell jonthysell removed their assignment Mar 20, 2020
@asklar asklar added the Needs: Triage 🔍 New issue that needs to be reviewed by the issue management team (label applied by bot) label Mar 24, 2020
@chrisglein chrisglein removed the Needs: Triage 🔍 New issue that needs to be reviewed by the issue management team (label applied by bot) label Mar 27, 2020
@chrisglein
Copy link
Member

Lots of potential next steps here.

First we need to remove any duplication between this and the website. Let's use this issue to track doing that first.

Then we need to make sure there's room for collaborator docs versus general app developer docs. Part of that is internal repo documentation, which could make sense as mds here or via the wiki. TBD. But first step, put things on the website that should be on the website, and delete them from here.

@chrisglein
Copy link
Member

I've tried to capture some of the deficiencies of the problems with the contribution docs in this issue in the samples repo (where Kiki has us tracking website issues). There's impact on the website, and also the repo. We need to break this down into actionable steps. First decision is: what's our philosophy about where contribution docs live? (then we can start deleting the duplicates)

@chrisglein chrisglein modified the milestones: 0.62 (M5), 0.63 (M6) May 29, 2020
@chrisglein
Copy link
Member

We've got some concrete follow ups filed in the docs repo. I think as is the issue here isn't actionable enough.
@asklar Is there more you want to capture? As is I think we should close this issue out and move forward with fine-grained issues.

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

Successfully merging a pull request may close this issue.

3 participants