Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Docs/fix #23

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

Merged
fulleni merged 8 commits into main from docs/fix
Oct 8, 2025
Merged

Docs/fix #23

fulleni merged 8 commits into main from docs/fix
Oct 8, 2025

Conversation

@fulleni
Copy link
Member

@fulleni fulleni commented Oct 8, 2025
edited
Loading

Status

READY

Description

This pull request primarily focuses on updating and expanding the project's documentation. The main intent is to improve the setup guides for the API server, mobile client, and web dashboard by changing the recommended source code acquisition method from Git cloning to downloading the latest release. Additionally, a new comprehensive guide has been added to explain how to connect a physical mobile device to a local API server using ngrok, and the mobile client deployment documentation has been enhanced with instructions for configuring app icons and native splash screens.

Type of Change

  • ✨ New feature (non-breaking change which adds functionality)
  • 🛠️ Bug fix (non-breaking change which fixes an issue)
  • ❌ Breaking change (fix or feature that would cause existing functionality to change)
  • 🧹 Code refactor
  • ✅ Build configuration change
  • 📝 Documentation
  • 🗑️ Chore

fulleni added 7 commits October 8, 2025 09:18
- Replace git clone instructions with download latest release
- Update API server URL to use HTTPS
- Remove automatic database seeding step
- Remove git clone instructions
- Replace with download latest release archive
- Update links to point to latest releases page
- Adjust language to reflect new process
- Remove step for cloning the repository
- Add step for downloading the latest release
- Update instructions for installing dependencies and running the app
- Add steps for configuring app icons using flutter_launcher_icons
- Add steps for configuring native splash screens using flutter_native_splash
- Update existing content for improved readability
...l device
- Include an additional Aside component to notify users about connecting to local API server from a physical mobile device
- Provide a link to the 'Development Environment Setup' guide for further configuration instructions
- New document explains how to set up development environment to test mobile app on physical device with local API server
- Covers using ngrok for tunneling and configuring app environment
- Includes step-by-step instructions and code examples
...device
- Add an aside note in the local setup guide
- Inform users about additional configuration for physical devices
- Link to the development environment setup guide for more details
Copy link

Summary of Changes

Hello @fulleni, I'm Gemini Code Assist1 ! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request primarily focuses on updating and expanding the project's documentation. The main intent is to improve the setup guides for the API server, mobile client, and web dashboard by changing the recommended source code acquisition method from Git cloning to downloading the latest release. Additionally, a new comprehensive guide has been added to explain how to connect a physical mobile device to a local API server using ngrok, and the mobile client deployment documentation has been enhanced with instructions for configuring app icons and native splash screens.

Highlights

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

Thank you for these documentation updates. The changes to standardize on downloading the latest release are a good improvement for user experience. I've added a few comments on areas that could be further improved for clarity and correctness. Please take a look.

- Removed the detailed documentation overview and getting started guide
- Retained the introductory paragraphs and badges
@fulleni fulleni merged commit 6d9c8b7 into main Oct 8, 2025
@fulleni fulleni deleted the docs/fix branch October 8, 2025 08:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@gemini-code-assist gemini-code-assist[bot] gemini-code-assist[bot] left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

AltStyle によって変換されたページ (->オリジナル) /