Skip to content

Conversation

pinkeshmars
Copy link
Collaborator

@pinkeshmars pinkeshmars commented May 21, 2024

Description

  1. Added Export code section
  2. Branching & Collaboration
  3. Testing (automated tests)
  4. Running your app

Linear ticket and magic word Fixes
Fixes DEVR-347
Fixes DEVR-345
Fixes DEVR-346
Fixes DEVR-344

Type of change

  • Typo fix
  • New feature
  • Removed outdated references

Copy link

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

@github-actions github-actions bot requested a review from PoojaB26 May 21, 2024 05:54
@pinkeshmars pinkeshmars requested a review from johnbhiggins7 May 21, 2024 05:55
@pinkeshmars pinkeshmars changed the title Added 'Exporting Code' section Added 'Exporting Code' + 'Branching & Collaboration' sections May 21, 2024
@pinkeshmars pinkeshmars changed the title Added 'Exporting Code' + 'Branching & Collaboration' sections Added Exporting Code, Branching & Collaboration, and Testing sections May 23, 2024
@pinkeshmars pinkeshmars changed the title Added Exporting Code, Branching & Collaboration, and Testing sections Added Exporting Code, Branching & Collaboration, Running and Testing sections May 28, 2024
# Branching
Branching creates a separate copy of your work, so you can add new features without disrupting your current progress. It enables multiple developers or teams to work simultaneously on different features without interfering with each other.

Suppose you have a digital cookbook app and you want to introduce a new feature, such as a shopping list. Instead of adding it directly to your main app and possibly causing issues, you create a branch to work on this new feature. Once it's done, you can bring it back into the main app.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should change to stay with the eComm example

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done!


![merge](../imgs/merge.avif)

### Resolve conflicts
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should show the config view as well

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added!

Copy link
Collaborator

@PoojaB26 PoojaB26 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work on this PR! Added some small requests and then this should be good to go.

**Bob's Changes (Branch: `feature-bob`)**

- Changes the button text to "Send"
- Changes the button color to green
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we make this part into a grid table with branch name and changes as columns? Might look cleaner and easier to explain.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done!

allow="clipboard-write">
</iframe>
</div>

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add p tag after this to create some space

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added!

allow="clipboard-write">
</iframe>
</div>

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add p tag

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added!

</iframe>
</div>

For certain conflicts, such as those involving variables and API configurations, you'll see a **View Configuration** option. Enabling this option allows you to easily identify what has changed.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Correct me if I'm wrong, but isnt this part about the generated code differences? If yes, i feel it should be highlighted in this section with a bit more details.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, internally, it is a generated code difference only, but we don't show this option for widget conflicts (although there is a conflict in the widget's generated code).


### Before merging or rebasing

Your feature branch has two commits: Commit 1 and Commit 3 (which are your changes), and Commit 2 (made by a colleague in the main branch).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add Commit 1 and Commit 3 kinda text under code tags

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added!

allow="clipboard-write">
</iframe>
</div>

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add p tags, and check all the pages and ensure arcades are not sticking with the text

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added!


To access the device logs, first run your app using the local run. Then, open the test menu and click on **Logs** icon. This will display a floating window with detailed logs of the app while it's running.

![access-device-logs](../imgs/access-device-logs.avif)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we pls scale down this image with some more padding on the sides so its not so blurry?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated!


If you need to update the Flutter SDK version, run Flutter Doctor, or start the simulator again, simply open the test menu and click **Configure**.

![reconfigure-local-run.avif](../imgs/reconfigure-local-run.avif)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same comment about scaling down

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done!


1. Take note of your FlutterFlow project version.

![check-flutter-version.avif](../imgs/check-flutter-version.avif)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same, scale down

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done!


---

## Troubleshooting
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we move the troubleshooting questions under expanded sections like FAQs so its easier to navigate and looks cleaner?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done!

@PoojaB26
Copy link
Collaborator

PoojaB26 commented Jun 7, 2024

One more ask: I forgot that we were writing the Github docs in this PR, and I had migrated the old docs to here without re-write, can you look into that section under Integrations and ensure all information is moved to your exporting code section and then remove my github integration folder completely from this PR? @pinkeshmars

@pinkeshmars
Copy link
Collaborator Author

Hey @PoojaB26, All your review comments are addressed now.

Copy link
Collaborator

@PoojaB26 PoojaB26 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for working on this!

@PoojaB26 PoojaB26 merged commit b5aec02 into main Jun 12, 2024
@PoojaB26 PoojaB26 deleted the pinkesh/export-code branch October 2, 2024 06:35
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.

3 participants