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

Write development-specific documentation #346

Open
7 tasks
achou11 opened this issue May 14, 2024 · 0 comments
Open
7 tasks

Write development-specific documentation #346

achou11 opened this issue May 14, 2024 · 0 comments
Labels
dev experience documentation Improvements or additions to documentation

Comments

@achou11
Copy link
Member

achou11 commented May 14, 2024

It'd be wise to include a file that has documentation specifically geared towards working on this project in development. things that are probably worth documenting (amongst other things):

  • Environment variables

  • Backend build process (e.g. Rollup for bundling, downloading native prebuilds, placing things in the correct places for NodeJS Mobile React Native)

  • Commonly run Expo commands, such as expo prebuild --clean

  • Useful ADB commands (e.g adb logcat, adb reverse tcp:8081 tcp:8081, etc.)

  • How translations generally work

  • Polyfill generation script

  • generating runnable apks locally (e.g. SENTRY_DISABLE_AUTO_UPLOAD=true eas build --profile test --platform android --local)

@achou11 achou11 added documentation Improvements or additions to documentation dev experience labels May 14, 2024
@achou11 achou11 changed the title development-specific documentation Write development-specific documentation May 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dev experience documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant