Skip to content

docs: update CODEBASE_GUIDE.md to reflect current codebase - #87

Merged
alichherawalla merged 1 commit into
mainfrom
docs/update-codebase-guide
Mar 1, 2026
Merged

alichherawalla merged 1 commit into
mainfrom
docs/update-codebase-guide

Conversation

@alichherawalla

Copy link
Copy Markdown
Collaborator

Summary

  • Syncs docs/standards/CODEBASE_GUIDE.md with the current codebase structure after recent refactoring
  • Updates directory tree to reflect folder-based splits (GenerationSettingsModal, ModelSelectorModal, VoiceRecordButton, ModelSettingsScreen, GalleryScreen, DownloadManagerScreen, activeModelService, modelManager, llm helpers)
  • Adds new files: spotlightConfig/spotlightState, ToolPickerSheet, MarkdownText, OrphanedFilesSection, logger, generateId, models.ts constants
  • Updates iOS native section (Swift files moved to ios/ root)
  • Merges foreground/background download docs into single background-only flow
  • Expands test infrastructure section (~108 test files across unit/integration/rntl/contract/e2e)
  • Updates Maestro E2E flows to p0/p1/p2/p3 tier structure

Test plan

  • Verify guide accuracy by spot-checking directory paths against actual codebase
  • No code changes — documentation only

Sync the comprehensive guide with all recent refactoring and feature
additions: folder-based component/screen/service splits, background-only
downloads, onboarding spotlight system, tool calling, expanded test
coverage (~108 files), iOS native file relocation, and new utilities.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@gemini-code-assist

Copy link
Copy Markdown
Contributor

Summary of Changes

Hello, 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 focuses on a significant documentation update to the codebase guide. The changes ensure that the guide accurately reflects the current architecture, file organization, and operational flows of the application after recent refactoring. The update provides a more precise and comprehensive resource for developers, covering structural changes, new features, and revised process descriptions, particularly for model management and testing.

Highlights

  • Documentation Sync: The CODEBASE_GUIDE.md has been comprehensively updated to reflect the current codebase structure following recent refactoring efforts.
  • Directory Structure Updates: Numerous components and services, such as GenerationSettingsModal, ModelSelectorModal, VoiceRecordButton, ModelSettingsScreen, GalleryScreen, DownloadManagerScreen, activeModelService, and modelManager, have been reorganized into dedicated folders, and the guide now reflects these changes.
  • New File Additions: Documentation for newly introduced files and concepts, including spotlightConfig/spotlightState, ToolPickerSheet, MarkdownText, OrphanedFilesSection, logger, generateId, and models.ts constants, has been added.
  • iOS Native Code Restructuring: The guide now accurately documents the updated iOS native section, where Swift files have been moved to the ios/ root directory.
  • Unified Background Download Flow: The documentation for model downloads has been streamlined, merging previous foreground and background download descriptions into a single, background-only flow for both platforms.
  • Expanded Test Infrastructure Details: The test infrastructure section has been significantly expanded, detailing approximately 108 test files across unit, integration, React Native Testing Library (RNTL), contract, and end-to-end (E2E) categories.
  • Maestro E2E Flow Tiering: Maestro E2E flows have been re-categorized into a p0/p1/p2/p3 tier structure, providing clearer prioritization and scope for automated testing.
Changelog
  • docs/standards/CODEBASE_GUIDE.md
    • Updated component and screen directory structures to reflect folder-based splits for modals, screens, and buttons.
    • Added documentation for new files such as AppSheet.styles.ts, spotlightConfig.tsx, spotlightState.ts, MarkdownText.tsx, ModelCard.styles.ts, ModelCardContent.tsx, ToolPickerSheet.tsx, ProjectDetailScreen.styles.ts, StorageSettingsScreen.styles.ts, OrphanedFilesSection.tsx, global.d.ts, models.ts, generateId.ts, and logger.ts.
    • Revised service documentation to reflect new folder structures for activeModelService and modelManager, and extracted llm helper files.
    • Adjusted iOS native code paths to show Swift files moved to the ios/ root.
    • Consolidated download process descriptions to emphasize background-only downloads and detailed recovery mechanisms.
    • Expanded the test infrastructure section with updated file counts, new test categories (hooks, onboarding, theme), and a tiered structure for Maestro E2E flows (P0, P1, P2, P3).
    • Added new documentation files: PRIVACY_POLICY.md and ONBOARDING_FLOWS.md.
    • Updated the 'Recommended Models' date to March 2026.
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. ↩

@sonarqubecloud

sonarqubecloud Bot commented Mar 1, 2026

Copy link
Copy Markdown

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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Code Review

This pull request provides a comprehensive update to the CODEBASE_GUIDE.md documentation to synchronize it with recent, significant refactoring across the codebase. The changes accurately reflect the new directory structures for components, screens, and services, as well as the addition of new files and the restructuring of the testing suite. The documentation for core services like ModelManager and BackgroundDownloadService has been updated to correctly describe the new background-only download flow and parallel downloads for vision models. The E2E test section is also updated to reflect the new tiered priority structure. The updates are thorough and significantly improve the documentation's accuracy and usefulness. No issues were found during the review.

@codecov

codecov Bot commented Mar 1, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 86.70%. Comparing base (bf04c9b) to head (a325d50).
⚠️ Report is 3 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main      #87   +/-   ##
=======================================
  Coverage   86.70%   86.70%           
=======================================
  Files         163      163           
  Lines        7272     7272           
  Branches     1994     1994           
=======================================
  Hits         6305     6305           
  Misses        541      541           
  Partials      426      426           
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@alichherawalla
alichherawalla merged commit c6fc6cb into main Mar 1, 2026
7 checks passed
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.

1 participant