Skip to content

chore: enhance setup instructions and development documentation#482

Open
Tobiloba0 wants to merge 1 commit into
rinafcode:mainfrom
Tobiloba0:issue-268-logging
Open

chore: enhance setup instructions and development documentation#482
Tobiloba0 wants to merge 1 commit into
rinafcode:mainfrom
Tobiloba0:issue-268-logging

Conversation

@Tobiloba0
Copy link
Copy Markdown

@Tobiloba0 Tobiloba0 commented May 29, 2026

#Closes #268

What Changed

This PR improves the TeachLink Mobile project documentation to make onboarding and local setup easier for new contributors.

Updates include:

  • Clear installation prerequisites (Node.js, Expo CLI, EAS CLI)
  • Improved local development instructions for iOS, Android, and web
  • Added Storybook usage guide for component development
  • Expanded testing instructions (unit, watch, coverage, single test file)
  • Enhanced logging system documentation (sync/async logging, context management, levels, and output formats)
  • Better environment variable setup explanation
  • Common troubleshooting section for Expo, Metro, iOS, and Android issues
  • Deployment workflow using EAS (development, preview, production builds)

Why

TeachLink Mobile has a complex setup due to Expo, Storybook, logging infrastructure, and EAS builds. This update reduces onboarding friction for new contributors and improves maintainability.

Testing

  • Verified setup instructions locally
  • Ensured all commands are valid and up-to-date
  • Checked formatting and consistency of documentation

#closes

@RUKAYAT-CODER
Copy link
Copy Markdown
Contributor

Kindly resolve conflict and fix workflow.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Implement background task scheduling for non-urgent work

2 participants