Skip to content

Conversation

@daretechie
Copy link
Owner

@daretechie daretechie commented Dec 23, 2025

User description

Updates README, adds Enterprise docs, removes dead Google stub code.


PR Type

Documentation, Other


Description

  • Remove dead Google Cloud document verifier stub implementation

  • Fix typo in README description text

  • Add comprehensive Enterprise edition documentation


Diagram Walkthrough

flowchart LR
  A["Dead Google Stub Code"] -->|Remove| B["Cleaner Codebase"]
  C["README Typo"] -->|Fix| D["Corrected Documentation"]
  E["Enterprise Features"] -->|Add| F["ENTERPRISE.md"]
  B --> G["Launch Ready"]
  D --> G
  F --> G
Loading

File Walkthrough

Relevant files
Cleanup
google-document.verifier.ts
Remove unused Google Cloud verifier stub                                 

src/infrastructure/adapters/document/google-document.verifier.ts

  • Removed entire file containing unused GoogleCloudDocumentVerifier
    class
  • Eliminates dead stub code that was not integrated into the system
  • Reduces codebase complexity before launch
+0/-33   
Documentation
README.md
Fix incomplete sentence in README                                               

README.md

  • Fixed incomplete sentence in the main value proposition section
  • Removed trailing text "when registries aren't available" that was cut
    off
  • Improves clarity of the core API description
+1/-1     
ENTERPRISE.md
Add Enterprise edition documentation                                         

docs/ENTERPRISE.md

  • Created new comprehensive Enterprise edition documentation
  • Documents SSO/SAML integration, RBAC, batch verification, and
    dedicated support features
  • Includes installation instructions with Docker, prerequisites, and
    licensing information
  • Provides contact information for sales and demos
+39/-0   

Summary by Sourcery

Update documentation for launch readiness and remove unused Google Cloud document verifier code.

Enhancements:

  • Remove the unused Google Cloud document verifier stub to reduce dead code in the infrastructure adapters.

Documentation:

  • Clarify the core README value proposition by fixing an incomplete sentence.
  • Add a new ENTERPRISE.md document detailing Enterprise features, deployment, licensing, and contact information.

@daretechie daretechie enabled auto-merge December 23, 2025 14:58
@qodo-code-review
Copy link

PR Compliance Guide 🔍

Below is a summary of compliance checks for this PR:

Security Compliance
Sensitive info exposure

Description: The documentation encourages passing LICENSE_KEY via docker run -e
LICENSE_KEY="ENT-XXXX-XXXX" (which can leak secrets via shell history, process lists, CI
logs, or shared terminals) and also publishes a personal email address
(deeprince2020@gmail.com) for licensing contact, which may be unintended sensitive/PII
exposure.
ENTERPRISE.md [24-39]

Referred Code
- A valid **License Key** (contact [sales@verimed.com](mailto:sales@verimed.com))
- Access to the private container registry (granted upon purchase)

### Running with Docker

```bash
docker run -d \
  -p 3000:3000 \
  -e LICENSE_KEY="ENT-XXXX-XXXX" \
  -e DATABASE_URL="postgres://..." \
  ghcr.io/daretechie/verimed-enterprise:latest

Get a License

To purchase a license or request a demo, please email deeprince2020@gmail.com.


</details></details></td></tr>
<tr><td colspan='2'><strong>Ticket Compliance</strong></td></tr>
<tr><td>⚪</td><td><details><summary>🎫 <strong>No ticket provided </strong></summary>


- [ ] Create ticket/issue <!-- /create_ticket --create_ticket=true -->

</details></td></tr>
<tr><td colspan='2'><strong>Codebase Duplication Compliance</strong></td></tr>
<tr><td>⚪</td><td><details><summary><strong>Codebase context is not defined </strong></summary>


Follow the <a href='https://qodo-merge-docs.qodo.ai/core-abilities/rag_context_enrichment/'>guide</a> to enable codebase context checks.

</details></td></tr>
<tr><td colspan='2'><strong>Custom Compliance</strong></td></tr>
<tr><td rowspan=6>🟢</td><td>
<details><summary><strong>Generic: Comprehensive Audit Trails</strong></summary><br>

**Objective:** To create a detailed and reliable record of critical system actions for security analysis <br>and compliance.<br>

**Status:** Passed<br>


> Learn more about managing compliance <a href='https://qodo-merge-docs.qodo.ai/tools/compliance/#configuration-options'>generic rules</a> or creating your own <a href='https://qodo-merge-docs.qodo.ai/tools/compliance/#custom-compliance'>custom rules</a>
</details></td></tr>
<tr><td>
<details><summary><strong>Generic: Meaningful Naming and Self-Documenting Code</strong></summary><br>

**Objective:** Ensure all identifiers clearly express their purpose and intent, making code <br>self-documenting<br>

**Status:** Passed<br>


> Learn more about managing compliance <a href='https://qodo-merge-docs.qodo.ai/tools/compliance/#configuration-options'>generic rules</a> or creating your own <a href='https://qodo-merge-docs.qodo.ai/tools/compliance/#custom-compliance'>custom rules</a>
</details></td></tr>
<tr><td>
<details><summary><strong>Generic: Robust Error Handling and Edge Case Management</strong></summary><br>

**Objective:** Ensure comprehensive error handling that provides meaningful context and graceful <br>degradation<br>

**Status:** Passed<br>


> Learn more about managing compliance <a href='https://qodo-merge-docs.qodo.ai/tools/compliance/#configuration-options'>generic rules</a> or creating your own <a href='https://qodo-merge-docs.qodo.ai/tools/compliance/#custom-compliance'>custom rules</a>
</details></td></tr>
<tr><td>
<details><summary><strong>Generic: Secure Error Handling</strong></summary><br>

**Objective:** To prevent the leakage of sensitive system information through error messages while <br>providing sufficient detail for internal debugging.<br>

**Status:** Passed<br>


> Learn more about managing compliance <a href='https://qodo-merge-docs.qodo.ai/tools/compliance/#configuration-options'>generic rules</a> or creating your own <a href='https://qodo-merge-docs.qodo.ai/tools/compliance/#custom-compliance'>custom rules</a>
</details></td></tr>
<tr><td>
<details><summary><strong>Generic: Secure Logging Practices</strong></summary><br>

**Objective:** To ensure logs are useful for debugging and auditing without exposing sensitive <br>information like PII, PHI, or cardholder data.<br>

**Status:** Passed<br>


> Learn more about managing compliance <a href='https://qodo-merge-docs.qodo.ai/tools/compliance/#configuration-options'>generic rules</a> or creating your own <a href='https://qodo-merge-docs.qodo.ai/tools/compliance/#custom-compliance'>custom rules</a>
</details></td></tr>
<tr><td>
<details><summary><strong>Generic: Security-First Input Validation and Data Handling</strong></summary><br>

**Objective:** Ensure all data inputs are validated, sanitized, and handled securely to prevent <br>vulnerabilities<br>

**Status:** Passed<br>


> Learn more about managing compliance <a href='https://qodo-merge-docs.qodo.ai/tools/compliance/#configuration-options'>generic rules</a> or creating your own <a href='https://qodo-merge-docs.qodo.ai/tools/compliance/#custom-compliance'>custom rules</a>
</details></td></tr>

<tr><td align="center" colspan="2">

<!-- placeholder --> <!-- /compliance --update_compliance=true -->

</td></tr></tbody></table>
<details><summary>Compliance status legend</summary>
🟢 - Fully Compliant<br>
🟡 - Partial Compliant<br>
🔴 - Not Compliant<br>
⚪ - Requires Further Human Verification<br>
🏷️ - Compliance label<br>
</details>

@sourcery-ai
Copy link

sourcery-ai bot commented Dec 23, 2025

Reviewer's Guide

Removes an unused Google Cloud document verifier adapter, fixes a README value-proposition sentence, and adds a new ENTERPRISE.md documenting the commercial/enterprise offering, its features, installation, and licensing.

Class diagram for removed GoogleCloudDocumentVerifier stub

classDiagram
  class GoogleCloudDocumentVerifier {
  }

  %% This class was removed in this PR as unused stub code
Loading

File-Level Changes

Change Details Files
Remove unused Google Cloud document verifier stub implementation from the infrastructure adapters.
  • Delete the google-document.verifier adapter file implementing GoogleCloudDocumentVerifier
  • Eliminate dead code that was never integrated into the document verification flow
  • Reduce surface area of the infrastructure/adapters/document layer before launch
src/infrastructure/adapters/document/google-document.verifier.ts
Tighten and correct the main value proposition sentence in the README.
  • Fix an incomplete sentence describing VeriMed’s purpose and core behavior
  • Remove trailing fragment about registries not being available to avoid confusion
  • Ensure marketing copy cleanly explains replacement of scraping with primary-source integrations
README.md
Add standalone Enterprise edition documentation for the commercial offering.
  • Create docs/ENTERPRISE.md describing enterprise-only features such as SSO/SAML, RBAC, batch verification, and dedicated support
  • Document installation via private Docker image and required prerequisites like license key and registry access
  • Provide licensing and sales contact details for acquiring an Enterprise license or demo
docs/ENTERPRISE.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@qodo-code-review
Copy link

PR Code Suggestions ✨

Explore these optional code suggestions:

CategorySuggestion                                                                                                                                    Impact
Possible issue
Replace personal email with professional one

Replace the personal contact email deeprince2020@gmail.com with the professional
sales email sales@verimed.com for consistency and professionalism on the
enterprise page.

docs/ENTERPRISE.md [39]

-To purchase a license or request a demo, please email **deeprince2020@gmail.com**.
+To purchase a license or request a demo, please email **sales@verimed.com**.
  • Apply / Chat
Suggestion importance[1-10]: 7

__

Why: The suggestion correctly identifies an unprofessional and inconsistent personal email in a customer-facing enterprise document and proposes using the official sales email mentioned elsewhere in the file, which significantly improves professionalism.

Medium
  • More

@daretechie daretechie merged commit 7f93ae5 into main Dec 23, 2025
3 checks passed
Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey - I've left some high level feedback:

  • In docs/ENTERPRISE.md, consider replacing the personal Gmail address with a domain-based or group email (e.g., sales@...) for a more professional and maintainable contact point.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- In `docs/ENTERPRISE.md`, consider replacing the personal Gmail address with a domain-based or group email (e.g., `sales@...`) for a more professional and maintainable contact point.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

daretechie added a commit that referenced this pull request Dec 23, 2025
Merge pull request #14 from daretechie/chore/launch-prep
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants