Skip to content

docs(website): Add Privacy Policy page#981

Merged
yamadashy merged 1 commit intomainfrom
docs/privacy-policy
Nov 29, 2025
Merged

docs(website): Add Privacy Policy page#981
yamadashy merged 1 commit intomainfrom
docs/privacy-policy

Conversation

@yamadashy
Copy link
Owner

Add a dedicated Privacy Policy page to the website, addressing user feedback about privacy information being hard to find on repomix.com.

Changes

  • Create Privacy Policy page with content from README (CLI, Website, Browser Extension, Liability Disclaimer)
  • Add sidebar links in the Community section for all supported languages
  • Non-English pages include English content via VitePress @include directive
  • Simplify README Privacy Policy section to link only to the website

Background

Discord user feedback indicated that privacy documentation was not easily discoverable on the website. Users who need to verify data handling for their work environment had to dig into the README to find this information.

Checklist

  • Run npm run test
  • Run npm run lint

Add a dedicated Privacy Policy page to the website, addressing user
feedback about privacy information being hard to find on repomix.com.

Changes:
- Create Privacy Policy page with content from README
- Add sidebar links for all supported languages
- Non-English pages include English content via @include
- Simplify README Privacy Policy section to link only

Related Discord feedback requested clearer privacy documentation
on the website for users who need to verify data handling before
using Repomix in their work environment.
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 29, 2025

Walkthrough

This PR adds comprehensive privacy policy documentation to the website across multiple languages. It updates the README with a privacy policy link, adds localized Privacy Policy navigation items to all language-specific VitePress configs, creates privacy guide pages (one English source with localized stub files containing includes), and removes detailed privacy subsections from the README in favor of a centralized policy page.

Changes

Cohort / File(s) Summary
Documentation Updates
README.md
Replaced detailed privacy subsections with a single link to centralized Privacy Policy page
VitePress Navigation Configuration
website/client/.vitepress/config/config{De,EnUs,Es,Fr,Hi,Id,Ja,Ko,PtBr,Vi,ZhCn,ZhTw}.ts
Added "Privacy Policy" navigation item under Community section in all language configs with respective locale-specific URLs (/de/guide/privacy, /guide/privacy, /es/guide/privacy, etc.)
English Privacy Guide
website/client/src/en/guide/privacy.md
New comprehensive privacy documentation covering CLI Tool, Website, Browser Extension, data collection practices, and liability disclaimer
Localized Privacy Guide Stubs
website/client/src/{de,es,fr,hi,id,ja,ko,pt-br,vi,zh-cn,zh-tw}/guide/privacy.md
New stub files for each language that include the English privacy guide content via include directive

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~15 minutes

  • Repetitive pattern: Config changes follow identical structure across 12 language files; privacy stubs all use the same include directive pattern
  • Single source of truth: English privacy.md is the main content; all localized versions simply reference it, minimizing content divergence risk
  • Areas to verify:
    • Correct URL paths for each language variant in config files
    • English privacy.md content completeness and accuracy
    • Include directive syntax consistency across all localized privacy files

Possibly related PRs

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the main change: adding a Privacy Policy page to the website documentation.
Description check ✅ Passed The description is comprehensive, covering changes, background context, and completed checklist items that match the template requirements.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs/privacy-policy

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @yamadashy, 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 significantly improves the accessibility of privacy information on repomix.com by migrating the detailed privacy policy from the README to a dedicated, easily navigable page on the website. This change directly addresses user feedback regarding the difficulty of locating privacy documentation, making it more prominent and available across all language versions of the site.

Highlights

  • New Privacy Policy Page: A dedicated Privacy Policy page has been added to the website, consolidating privacy information previously scattered or hard to find.
  • Improved Discoverability: Sidebar navigation links for the new Privacy Policy page have been added across all supported languages to enhance user discoverability.
  • Multilingual Support: Non-English versions of the Privacy Policy page utilize VitePress's @include directive to display the English content, ensuring consistency and ease of maintenance.
  • README Simplification: The Privacy Policy section in the main README.md has been simplified to a direct link to the new, comprehensive website page.
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.

{ text: 'Community-Projekte', link: '/de/guide/community-projects' },
{ text: 'Zu Repomix beitragen', link: '/de/guide/development/' },
{ text: 'Sponsoren', link: '/de/guide/sponsors' },
{ text: 'Privacy Policy', link: '/de/guide/privacy' },
Copy link
Contributor

Choose a reason for hiding this comment

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

The Privacy Policy link text should be translated to German for consistency with the rest of the navigation. Consider using 'Datenschutzerklärung' instead of 'Privacy Policy'.

Suggested change
{ text: 'Privacy Policy', link: '/de/guide/privacy' },
{ text: 'Datenschutzerklärung', link: '/de/guide/privacy' },

{ text: 'Proyectos de la Comunidad', link: '/es/guide/community-projects' },
{ text: 'Contribuir a Repomix', link: '/es/guide/development/' },
{ text: 'Patrocinadores', link: '/es/guide/sponsors' },
{ text: 'Privacy Policy', link: '/es/guide/privacy' },
Copy link
Contributor

Choose a reason for hiding this comment

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

The Privacy Policy link text should be translated to Spanish for consistency. Consider using 'Política de privacidad'.

Suggested change
{ text: 'Privacy Policy', link: '/es/guide/privacy' },
{ text: 'Política de privacidad', link: '/es/guide/privacy' },

{ text: 'Projets de la Communauté', link: '/fr/guide/community-projects' },
{ text: 'Contribuer à Repomix', link: '/fr/guide/development/' },
{ text: 'Sponsors', link: '/fr/guide/sponsors' },
{ text: 'Privacy Policy', link: '/fr/guide/privacy' },
Copy link
Contributor

Choose a reason for hiding this comment

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

The Privacy Policy link text should be translated to French. Consider using 'Politique de confidentialité'.

Suggested change
{ text: 'Privacy Policy', link: '/fr/guide/privacy' },
{ text: 'Politique de confidentialité', link: '/fr/guide/privacy' },

{ text: 'コミュニティプロジェクト', link: '/ja/guide/community-projects' },
{ text: 'Repomixに貢献する', link: '/ja/guide/development/' },
{ text: 'スポンサー', link: '/ja/guide/sponsors' },
{ text: 'Privacy Policy', link: '/ja/guide/privacy' },
Copy link
Contributor

Choose a reason for hiding this comment

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

The Privacy Policy link text should be translated to Japanese. Consider using 'プライバシーポリシー'.

Suggested change
{ text: 'Privacy Policy', link: '/ja/guide/privacy' },
{ text: 'プライバシーポリシー', link: '/ja/guide/privacy' },

Copy link
Contributor

@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

This pull request effectively addresses user feedback by creating a dedicated Privacy Policy page on the website, making this important information more discoverable. The changes are well-structured: the privacy content is moved from the README.md to a new page, sidebar links are added for all supported languages, and non-English pages correctly reuse the English content to avoid duplication.

My review focuses on improving the internationalization of the new sidebar links. While the page content is intentionally in English for all languages, the link text in the sidebar should be translated to match the language of the other navigation items for a consistent user experience. I've left specific suggestions for each language configuration file.

Overall, this is a great improvement to the website's documentation and user-friendliness.

{ text: 'Community-Projekte', link: '/de/guide/community-projects' },
{ text: 'Zu Repomix beitragen', link: '/de/guide/development/' },
{ text: 'Sponsoren', link: '/de/guide/sponsors' },
{ text: 'Privacy Policy', link: '/de/guide/privacy' },
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

For consistency with other items in the German sidebar, the text for the new link should be translated to German.

Suggested change
{ text: 'Privacy Policy', link: '/de/guide/privacy' },
{ text: 'Datenschutzrichtlinie', link: '/de/guide/privacy' },

{ text: 'Proyectos de la Comunidad', link: '/es/guide/community-projects' },
{ text: 'Contribuir a Repomix', link: '/es/guide/development/' },
{ text: 'Patrocinadores', link: '/es/guide/sponsors' },
{ text: 'Privacy Policy', link: '/es/guide/privacy' },
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

For consistency with other items in the Spanish sidebar, the text for the new link should be translated to Spanish.

Suggested change
{ text: 'Privacy Policy', link: '/es/guide/privacy' },
{ text: 'Política de Privacidad', link: '/es/guide/privacy' },

{ text: 'Projets de la Communauté', link: '/fr/guide/community-projects' },
{ text: 'Contribuer à Repomix', link: '/fr/guide/development/' },
{ text: 'Sponsors', link: '/fr/guide/sponsors' },
{ text: 'Privacy Policy', link: '/fr/guide/privacy' },
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

For consistency with other items in the French sidebar, the text for the new link should be translated to French.

Suggested change
{ text: 'Privacy Policy', link: '/fr/guide/privacy' },
{ text: 'Politique de Confidentialité', link: '/fr/guide/privacy' },

{ text: 'समुदाय प्रोजेक्ट्स', link: '/hi/guide/community-projects' },
{ text: 'Repomix में योगदान', link: '/hi/guide/development/' },
{ text: 'प्रायोजक', link: '/hi/guide/sponsors' },
{ text: 'Privacy Policy', link: '/hi/guide/privacy' },
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

For consistency with other items in the Hindi sidebar, the text for the new link should be translated to Hindi.

Suggested change
{ text: 'Privacy Policy', link: '/hi/guide/privacy' },
{ text: 'गोपनीयता नीति', link: '/hi/guide/privacy' },

@cloudflare-workers-and-pages
Copy link

Deploying repomix with  Cloudflare Pages  Cloudflare Pages

Latest commit: 265a510
Status: ✅  Deploy successful!
Preview URL: https://70137e7c.repomix.pages.dev
Branch Preview URL: https://docs-privacy-policy.repomix.pages.dev

View logs

@codecov
Copy link

codecov bot commented Nov 29, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.38%. Comparing base (1734471) to head (265a510).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #981   +/-   ##
=======================================
  Coverage   90.38%   90.38%           
=======================================
  Files         110      110           
  Lines        7890     7890           
  Branches     1528     1528           
=======================================
  Hits         7131     7131           
  Misses        759      759           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 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.

@claude
Copy link
Contributor

claude bot commented Nov 29, 2025

Code Review Summary

Thank you for this PR! The addition of a dedicated Privacy Policy page addresses an important user need and significantly improves the discoverability of privacy information. The implementation is clean and follows the existing website structure well.

✅ Strengths

  • Excellent solution to the user feedback about privacy information being hard to find
  • Smart use of VitePress's @include directive for maintaining a single source of truth
  • Proper integration with the existing navigation structure
  • Comprehensive privacy information covering CLI, website, and browser extension

🔧 Suggestions for Improvement

1. **Localization Consistency**

I've left inline comments on the configuration files - the "Privacy Policy" link text should be translated to match each language's navigation. This maintains consistency with the localized user experience.

2. **Consider Adding Metadata**

Consider adding page metadata (title, description) to the English privacy.md file for better SEO:

---
title: Privacy Policy
description: Learn about Repomix's privacy practices for the CLI tool, website, and browser extension
---
3. **Future Enhancement: Privacy Page Translations**

While using @include for non-English versions works well for now, consider translating the actual privacy content in the future for a fully localized experience. This could be tracked as a separate issue for community contributions.

🔍 Premortem Analysis

Potential Failure Scenarios
  1. Build Issues: The VitePress @include directive should work correctly, but verify the build process handles it properly in production.

    • Mitigation: The PR mentions tests were run successfully ✅
  2. Navigation Inconsistency: Mixed language navigation (English "Privacy Policy" in non-English sites) might confuse users.

    • Mitigation: Apply the suggested translations for link text
  3. Content Drift: As privacy practices evolve, keeping the content current is important.

    • Mitigation: Consider adding a "Last Updated" date to the privacy page

✅ Test Coverage

The PR checklist confirms:

  • Tests have been run successfully
  • Linting has passed

🎯 Overall Assessment

This is a well-executed improvement that directly addresses user feedback. With the minor localization adjustments suggested above, this PR will provide excellent value to users who need quick access to privacy information.

Great work on implementing this user-requested feature! 🚀

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 7

🧹 Nitpick comments (5)
website/client/.vitepress/config/configDe.ts (1)

51-57: Link path is correct; consider localizing label

The new sidebar item correctly links to /de/guide/privacy and fits the existing structure. You may optionally want to localize the label (e.g., “Datenschutzerklärung”) for consistency with the rest of the German UI.

website/client/.vitepress/config/configHi.ts (1)

51-57: Route is consistent; optional Hindi translation for label

The /hi/guide/privacy link is consistent with the rest of the Hindi guide routes. If you’d like full localization in the sidebar, you could translate the label (e.g., a Hindi equivalent of “Privacy Policy”) while keeping the slug as is.

website/client/.vitepress/config/configId.ts (1)

54-60: Correct Indonesian route; label can optionally be localized

The new entry correctly targets /id/guide/privacy and is aligned with the existing sidebar structure. Consider localizing “Privacy Policy” into Indonesian for consistency with the rest of the “Komunitas” section if you prefer fully localized nav text.

website/client/.vitepress/config/configZhCn.ts (1)

48-54: Route is correct; consider Chinese label for consistency

The /zh-cn/guide/privacy link integrates properly under the 社区 section. If you prefer full localization, you might rename the text to a Chinese equivalent (e.g., “隐私政策”) while keeping the same path.

website/client/src/en/guide/privacy.md (1)

1-25: Add contact information and regulatory compliance details.

The privacy policy is clear and well-structured, but is missing some standard elements that strengthen user trust and legal compliance:

  • No contact method for privacy inquiries – users may have questions or requests (e.g., data deletion under GDPR/CCPA)
  • No mention of regulatory compliance – frameworks like GDPR (EU users), CCPA (California), or other applicable laws
  • Liability disclaimer is minimal – consider expanding to clarify responsibility boundaries for data misuse or breaches

Consider adding a footer section with contact information (e.g., privacy inquiry email) and a brief statement on compliance with applicable privacy regulations.

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1734471 and 265a510.

📒 Files selected for processing (25)
  • README.md (1 hunks)
  • website/client/.vitepress/config/configDe.ts (1 hunks)
  • website/client/.vitepress/config/configEnUs.ts (1 hunks)
  • website/client/.vitepress/config/configEs.ts (1 hunks)
  • website/client/.vitepress/config/configFr.ts (1 hunks)
  • website/client/.vitepress/config/configHi.ts (1 hunks)
  • website/client/.vitepress/config/configId.ts (1 hunks)
  • website/client/.vitepress/config/configJa.ts (1 hunks)
  • website/client/.vitepress/config/configKo.ts (1 hunks)
  • website/client/.vitepress/config/configPtBr.ts (1 hunks)
  • website/client/.vitepress/config/configVi.ts (1 hunks)
  • website/client/.vitepress/config/configZhCn.ts (1 hunks)
  • website/client/.vitepress/config/configZhTw.ts (1 hunks)
  • website/client/src/de/guide/privacy.md (1 hunks)
  • website/client/src/en/guide/privacy.md (1 hunks)
  • website/client/src/es/guide/privacy.md (1 hunks)
  • website/client/src/fr/guide/privacy.md (1 hunks)
  • website/client/src/hi/guide/privacy.md (1 hunks)
  • website/client/src/id/guide/privacy.md (1 hunks)
  • website/client/src/ja/guide/privacy.md (1 hunks)
  • website/client/src/ko/guide/privacy.md (1 hunks)
  • website/client/src/pt-br/guide/privacy.md (1 hunks)
  • website/client/src/vi/guide/privacy.md (1 hunks)
  • website/client/src/zh-cn/guide/privacy.md (1 hunks)
  • website/client/src/zh-tw/guide/privacy.md (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (15)
  • GitHub Check: Test (macos-latest, 24.x)
  • GitHub Check: Test (windows-latest, 20.x)
  • GitHub Check: Test (ubuntu-latest, 25.x)
  • GitHub Check: Test (windows-latest, 25.x)
  • GitHub Check: Test (windows-latest, 24.x)
  • GitHub Check: Test (windows-latest, 22.x)
  • GitHub Check: Build and run (ubuntu-latest, 24.x)
  • GitHub Check: Lint Browser Extension
  • GitHub Check: Lint GitHub Actions
  • GitHub Check: Lint Secretlint
  • GitHub Check: Build and run with Bun (windows-latest, latest)
  • GitHub Check: Test with Bun (windows-latest, latest)
  • GitHub Check: Update configuration json schema
  • GitHub Check: claude-review
  • GitHub Check: Cloudflare Pages
🔇 Additional comments (13)
website/client/src/ja/guide/privacy.md (1)

1-1: Include path and reuse look correct

The include directive correctly points to the English source privacy page and keeps content centralized; this is a clean, low-maintenance setup.

website/client/.vitepress/config/configEnUs.ts (1)

51-57: Canonical privacy nav entry looks good

The “Privacy Policy” item under Community correctly links to /guide/privacy and matches the existing English navigation patterns.

website/client/src/zh-tw/guide/privacy.md (1)

1-1: Shared English source include is correctly wired

The include directive cleanly reuses the English privacy content, keeping the Traditional Chinese page in sync without duplication.

website/client/src/fr/guide/privacy.md (1)

1-1: Centralized privacy content via include is fine here

The French page correctly includes the English privacy source, avoiding content drift and keeping maintenance simple.

website/client/src/es/guide/privacy.md (1)

1-1: LGTM! Clean content reuse approach.

The VitePress include directive correctly references the English privacy content, enabling consistent privacy information across locales.

website/client/src/de/guide/privacy.md (1)

1-1: LGTM! Consistent with other locale implementations.

The include directive correctly references the centralized English privacy content.

website/client/src/pt-br/guide/privacy.md (1)

1-1: LGTM! Follows the established pattern.

The include directive correctly reuses the English privacy documentation.

website/client/src/ko/guide/privacy.md (1)

1-1: LGTM! Consistent implementation.

The include directive correctly references the centralized English privacy content.

README.md (1)

1652-1652: LGTM! Privacy policy successfully centralized.

The change effectively consolidates detailed privacy information into a single, discoverable location on the website. This addresses the user feedback mentioned in the PR objectives about privacy documentation being hard to find.

website/client/src/zh-cn/guide/privacy.md (1)

1-1: English privacy guide exists with complete content.

The verification confirms that website/client/src/en/guide/privacy.md exists and contains a well-structured privacy policy covering the CLI tool, website, and browser extension. The include directive in the Chinese localized version will function correctly.

website/client/src/en/guide/privacy.md (3)

12-15: Verify the file deletion claim and expand website privacy details.

The statement that uploaded files are "automatically deleted immediately after processing" is a strong claim that directly affects user trust. Additionally, the website privacy section lacks important details:

  • Data retention policy for Google Analytics
  • Clarification on whether files are truly deleted with zero delay (or if there's any temporary storage, backups, or logging)
  • Other tracking mechanisms (cookies, pixels, etc.)
  • Data sharing policies with third parties

Please verify:

  1. What is the exact backend behavior for uploaded file cleanup (timing, logging, backups)?
  2. Are there other tracking methods besides Google Analytics (cookies, session tracking, etc.)?
  3. What is the data retention policy for analytics data?

Once verified, consider expanding this section to include these details for full transparency.


3-10: CLI tool privacy section looks good.

Clear, concise, and accurate. The offline-first design and transparent list of when internet is needed build confidence.


17-20: Browser extension privacy section is well-documented.

Clearly states minimal data collection and permissions model. Good transparency.

@yamadashy yamadashy merged commit 8dc691d into main Nov 29, 2025
91 checks passed
@yamadashy yamadashy deleted the docs/privacy-policy branch November 29, 2025 10:36
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