Improve onboarding documentation #1723
Description
The current onboarding documentation is a bit thin, and may not be super easy to follow. The following improvements should be made:
- Easy way to get to the onboarding instructions (e.g. via a README--this should be solved with Add README.md #560)
- Ensure the onboarding flow leads into follow-up documentation: architecture overview, code style, submission guidelines, how to make UX changes, how to contribute large projects (which should tie into design documents), and best practices Fix #5073, #5062, #5099, and part of #1723: Improve Onboarding Documentation #5174
- Ensure there's supporting documentation for all key technologies: data-binding, Bazel, Kotlin, and Android development (suggest linking to a bootcamp to help people get started)
- Ensure the installation instructions provide support for folks both using emulators and physical Android devices Fix #2746 and Fix part of #1723: Update Onboarding Instructions and Bazel Documentation #5723
- Ensure there's a cheat sheet for quick operations: running the app, building & running tests, running the linter, etc.
- Ensure there's a page providing guidance on making code changes (including dealing with Bazel) Fix #4622: Android Wiki migration #4893
- Known issues that have come up in discussions Fix #5073, #5062, #5099, and part of #1723: Improve Onboarding Documentation #5174
Metadata
Metadata
Assignees
Labels
Moderate perceived user impact (non-blocking bugs and general improvements).Indicates that an issue is too large and should be broken into smaller chunks.The means to find the solution is clear, but it isn't at good-first-issue level yet.Temporary label for Ben to keep track of issues he's triaged.End user-perceivable behaviors which are not desirable.