Conversation
… unsure what the project_filebrowser.db file in my staged changes is but it will not allow me to not commit. feel free to review and discard edit.
Contributor
📝 WalkthroughWalkthroughThis pull request updates documentation files across the repository, primarily normalizing file endings with trailing newlines. Substantive changes include updates to architecture.md with enhanced cloud infrastructure and database specifications, along with a clarified purpose statement in notebook_setup.md. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment Tip You can validate your CodeRabbit configuration file in your editor.If your editor has YAML language server, you can enable auto-completion and validation by adding |
Collaborator
Author
|
My pixi run pre-commit-all does the whitespace trimming thing, so it makes it look like more edits were made than they actually were with "13 files changed" when actually its about 2. |
Contributor
There was a problem hiding this comment.
Pull request overview
Updates project documentation and documentation pointers as part of a broader docs review, while also modifying the Pixi lockfile configuration for PyPI resolution and local package installation mode.
Changes:
- Edited
docs/architecture.mdanddocs/notebook_setup.mdfor clarity/accuracy and added TODO notes. - Updated multiple
docs/**/README.mdpointer files (appear to be symlink-like stubs). - Updated
pixi.lock(removedpypi-prerelease-modeoptions; marked local packages aseditable: true).
Reviewed changes
Copilot reviewed 2 out of 13 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| pixi.lock | Alters Pixi/PyPI resolution options and local package install mode (editable). |
| docs/architecture.md | Updates infra/version statements and adds TODO notes; removes the prior “Overview” section. |
| docs/notebook_setup.md | Minor wording/punctuation change in the purpose statement. |
| docs/webservice/README.md | Updates a pointer/stub line (potentially symlink-related). |
| docs/resources/README.md | Updates a pointer/stub line (potentially symlink-related). |
| docs/pipeline/README.md | Updates a pointer/stub line (potentially symlink-related). |
| docs/deployment/README.md | Updates a pointer/stub line (potentially symlink-related). |
| docs/datamodels/README.md | Updates a pointer/stub line (potentially symlink-related). |
| docs/README.md | Updates a pointer/stub line (potentially symlink-related). |
| docs/ERD_VIEW.md | Updates a pointer/stub line (potentially symlink-related). |
| docs/CONTRIBUTING.md | Updates a pointer/stub line (potentially symlink-related). |
| docs/CODE_OF_CONDUCT.md | Updates a pointer/stub line (potentially symlink-related). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
| - **Production deployment:** All core infrastructure (database, application | ||
| containers, orchestration, and secrets) runs on GCP using Cloud SQL, Cloud | ||
| Run, Artifact Registry, and Secret Manager | ||
| - **Database Hosting:** PostgreSQL 17+ with PostGIS (Cloud SQL on GCP for |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
docs/architecture.md (2)
315-318: Good practice to flag potentially outdated content.The TODO comment appropriately signals to reviewers and future maintainers that this section needs verification. Consider creating a tracking issue to ensure this review happens.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/architecture.md` around lines 315 - 318, The TODO note marking the "Core Domain Models" section as potentially outdated should be replaced with an actionable tracking reference: create a ticket (e.g., in your issue tracker) to review and update the "Core Domain Models" section and then update the comment to include the ticket ID/URL, an assignee, and a target review date; specifically edit the TODO block in docs/architecture.md around the "Core Domain Models" header to reference the new issue, include a short checklist (verify model names, relationships, and examples) and mark the task as pending so reviewers can see status until the doc is updated.
509-512: Good practice to flag future documentation improvements.The TODO comment appropriately notes the opportunity to make this section more descriptive. Consider creating a tracking issue to prioritize this work.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/architecture.md` around lines 509 - 512, Create a tracking issue in the project tracker for the documentation rewrite referenced by the TODO and update the TODO in docs/architecture.md (the comment containing "TODO (2026-03-12)") to reference that issue ID or URL, include an owner and priority, and add a short note about the expected scope (reduce bullet reliance, add descriptive language and future architecture considerations) so the TODO is actionable and discoverable.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/architecture.md`:
- Line 89: Update the inconsistent database version wording so the "Database"
bullet (the line starting with "**Database**: PostgreSQL 13+ (17 in dev/staging)
with PostGIS extension") and the later sentence that reads "PostgreSQL 17+ with
PostGIS (Cloud SQL on GCP for production, local PostGIS for development)" convey
the same environment mapping; explicitly state which PostgreSQL major version is
used for production, staging, and development (e.g., "Production: PostgreSQL 17+
on Cloud SQL with PostGIS; Staging: PostgreSQL 17; Development: PostgreSQL 13+
with local PostGIS") and replace one of the conflicting lines with that
definitive mapping so both the "**Database**" bullet and the "PostgreSQL 17+
with PostGIS..." sentence match.
---
Nitpick comments:
In `@docs/architecture.md`:
- Around line 315-318: The TODO note marking the "Core Domain Models" section as
potentially outdated should be replaced with an actionable tracking reference:
create a ticket (e.g., in your issue tracker) to review and update the "Core
Domain Models" section and then update the comment to include the ticket ID/URL,
an assignee, and a target review date; specifically edit the TODO block in
docs/architecture.md around the "Core Domain Models" header to reference the new
issue, include a short checklist (verify model names, relationships, and
examples) and mark the task as pending so reviewers can see status until the doc
is updated.
- Around line 509-512: Create a tracking issue in the project tracker for the
documentation rewrite referenced by the TODO and update the TODO in
docs/architecture.md (the comment containing "TODO (2026-03-12)") to reference
that issue ID or URL, include an owner and priority, and add a short note about
the expected scope (reduce bullet reliance, add descriptive language and future
architecture considerations) so the TODO is actionable and discoverable.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 1387c6e3-6167-4845-ab6b-99867e6ec2f5
⛔ Files ignored due to path filters (2)
anaconda_projects/db/project_filebrowser.dbis excluded by!**/*.dbpixi.lockis excluded by!**/*.lock
📒 Files selected for processing (11)
docs/CODE_OF_CONDUCT.mddocs/CONTRIBUTING.mddocs/ERD_VIEW.mddocs/README.mddocs/architecture.mddocs/datamodels/README.mddocs/deployment/README.mddocs/notebook_setup.mddocs/pipeline/README.mddocs/resources/README.mddocs/webservice/README.md
|
|
||
| - **Programming Language**: Python 3.12+ | ||
| - **Database**: PostgreSQL 13+ with PostGIS extension | ||
| - **Database**: PostgreSQL 13+ (17 in dev/staging) with PostGIS extension |
Contributor
There was a problem hiding this comment.
Database version inconsistency with line 127-128.
Line 89 states PostgreSQL 17 is used in "dev/staging", but lines 127-128 state "PostgreSQL 17+ with PostGIS (Cloud SQL on GCP for production, local PostGIS for development)". This creates confusion about which environments use which PostgreSQL versions.
Please clarify:
- Is PostgreSQL 17+ used in production (as line 127 suggests)?
- Is PostgreSQL 13+ still the minimum for development?
- What version is used in dev/staging vs production?
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/architecture.md` at line 89, Update the inconsistent database version
wording so the "Database" bullet (the line starting with "**Database**:
PostgreSQL 13+ (17 in dev/staging) with PostGIS extension") and the later
sentence that reads "PostgreSQL 17+ with PostGIS (Cloud SQL on GCP for
production, local PostGIS for development)" convey the same environment mapping;
explicitly state which PostgreSQL major version is used for production, staging,
and development (e.g., "Production: PostgreSQL 17+ on Cloud SQL with PostGIS;
Staging: PostgreSQL 17; Development: PostgreSQL 13+ with local PostGIS") and
replace one of the conflicting lines with that definitive mapping so both the
"**Database**" bullet and the "PostgreSQL 17+ with PostGIS..." sentence match.
Rewrite docs symlink entries without trailing newline payloads so Windows checkout/restore operations do not produce unreadable links. No content changes to target markdown files; only symlink metadata normalization.
- remove ERD_VIEW docs page references/files - update mkdocs repo URL to sustainability-software-lab - refresh pipeline and datamodels readmes for current structure - apply contributing/deployment workflow doc edits
Previous overneiw was redundant with documentation overview page and contained misleading language. This new version maintains benefits of an overview paragraph while removing misleading language. Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Collaborator
Author
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
📄 Description
PR for branch for making documentation edits as part of thorough review. Welcome other to make edits on this branch/PR. If it doesn't fall within the "code freeze" goals, or code revision priorities before handoff, I can save edits locally and apply to the codebase in the next UC Berkeley owned repo.
I will flag high level concerns for discussion on Tuesday meeting. UW team can decide if it is important that they revise docs before handoff, or can be left to UC Berkeley/LBL team for later.
✅ Checklist
pre-commit run --all-filesand all checks pass🔗 Related Issues
Resolves #163
💡 Type of change
🧪 How to test
📝 Notes to reviewers
Docs review is in progress. More observations/considerations are noted in issue #163 for discussion than actual edits made in this PR. Future commits to this PR will populate as more documents are reviewed.
Summary by CodeRabbit