Skip to content

Feature/improve documentation #642

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 4 commits into
base: dev
Choose a base branch
from
Open

Feature/improve documentation #642

wants to merge 4 commits into from

Conversation

sobuur0
Copy link

@sobuur0 sobuur0 commented Sep 14, 2025 •
edited
Loading

Description of the change

Improve documentation and development setup

What Changed

  • created comprehensive monorepo README: Replaced generic flutter template with developer focused guide
  • Added development setup instructions: Step by step guide for contributors including code generation requirements
  • Documented common issues and solutions: Troubleshooting section for setup problems developers encounter
  • Updated gitignore: Added fvm and vscode support for better developer experience
  • Made build scripts executable: Fixed permissions on development scripts

Why This Matters

  • Solves contributor onboarding issues: New developers can now set up the project without hitting import/generation
    errors
  • Explains monorepo structure: Clear overview of the 4 packages and their purposes

Type of change

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Related issues

Issue links go here

Checklists

Development

  • Lint rules pass locally
  • The code changed/added as part of this pull request has been covered with tests

Code review

  • This pull request has a descriptive title and information useful to a reviewer
  • Issue from task tracker has a link to this pull request

Requesting review from repo owners:
@ahmedAlaaInstabug @AndrewAminInstabug

@sobuur0
resolve: pubspec.lock conflicts with upstream
49051c1
@sobuur0
chore: update gitignore for FVM and VSCode
d593fcd 
- Add .fvm/ directory for Flutter Version Management
- Add .fvmrc file for FVM configuration
- Add .vscode/ directory for VSCode settings
@sobuur0
chore: make pigeon generation script executable
b9506e2 
- Update scripts/pigeon.sh permissions for code generation
- Required for generating Pigeon API files during development
@sobuur0
docs: create comprehensive monorepo README
1cc03f9 
- Replace generic Flutter template with developer-focused guide
- Add detailed development setup instructions for contributors
- Include code generation steps (Pigeon, build_runner) to solve common setup issues
- Explain monorepo structure with 4 packages overview
- Add troubleshooting section for common development problems
- Provide clear separation between repo-level and package-level documentation
- Include contributing guidelines and development workflow
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@sobuur0