Skip to content

Conversation

@paxcalpt
Copy link
Contributor

@paxcalpt paxcalpt commented Feb 2, 2026

Summary

Security Fix: Removes references to the private website-rxiv-maker GitHub repository from public documentation files, complying with CLAUDE.md security guidelines.

Issue

CLAUDE.md explicitly states (line 338):

⚠️ IMPORTANT: The website-rxiv-maker repository is private - do NOT reference it in public documentation

However, public documentation files violated this rule by including direct GitHub repository links.

Changes Made

1. CHANGELOG.md

  • Line 1160: Replaced [website-rxiv-maker](https://github.com/HenriquesLab/website-rxiv-maker)[official documentation website](https://rxiv-maker.henriqueslab.org)
  • Line 1163: Removed website-rxiv-maker from ecosystem list

2. docs/ECOSYSTEM.md

  • Line 39: Updated mermaid diagram node from website-rxiv-makerDocumentation Website
  • Line 75: Changed repository table entry to reference deployed website
  • Line 257: Updated release workflow diagram reference
  • Line 441: Updated technical stats table

Security Impact

Before: Public documentation exposed:

  • Private repository structure
  • Internal development processes
  • Repository naming conventions

After: Public documentation references only:

Verification

# Verify no private repo references remain
grep -n "website-rxiv-maker" CHANGELOG.md docs/ECOSYSTEM.md
# Returns: 0 matches

All references now point to the public deployed website, maintaining user access to documentation while protecting internal repository information.

Related

  • Complies with CLAUDE.md security guidelines (line 338)
  • Identified by security audit of public documentation
  • No functional changes - documentation links remain valid

Priority: High - Security/Privacy compliance
Risk: Low - Documentation-only changes, no code modifications
Testing: ✅ Pre-commit hooks passed, no broken links

paxcalpt and others added 2 commits February 2, 2026 10:42
Create reusable templates for Homebrew formula documentation:

1. HOMEBREW_FORMULA_TEMPLATE.md:
   - Standard template for CONTRIBUTING.md sections
   - Standard template for CLAUDE.md sections
   - Customization guide with package name replacements
   - Examples for rxiv-maker, TaskRepo, folder2md4llms
   - Consistency checklist

2. HOMEBREW_DOCS_CHECKLIST.md:
   - Quick review checklist for CONTRIBUTING.md and CLAUDE.md
   - Common issues detection (hardcoded versions, absolute paths)
   - Repository-specific checks
   - Automated review patterns
   - Reference to related PRs

Benefits:
- Ensures consistency across HenriquesLab ecosystem
- Provides clear guidance for new package additions
- Facilitates automated review detection
- Documents established patterns from PR #280, #37, #12

Template can be used for future packages and for reviewing existing
documentation across the organization.

Co-Authored-By: Claude Sonnet 4.5 <[email protected]>
Remove references to private website-rxiv-maker GitHub repository
from public documentation, as per CLAUDE.md security guidelines.

Changes:
1. CHANGELOG.md:
   - Replace GitHub repo link with deployed website URL
   - Remove website-rxiv-maker from ecosystem list

2. docs/ECOSYSTEM.md:
   - Update mermaid diagram node (website-rxiv-maker → Documentation Website)
   - Update repository table with deployed website URL
   - Update release workflow diagram
   - Update technical stats table

All references now point to the public deployed website:
https://rxiv-maker.henriqueslab.org

Complies with CLAUDE.md line 338:
"The website-rxiv-maker repository is **private** - do NOT reference
it in public documentation"

Security impact: Prevents exposure of private repository structure
and internal development processes.

Co-Authored-By: Claude Sonnet 4.5 <[email protected]>
Copilot AI review requested due to automatic review settings February 2, 2026 11:03
@github-actions
Copy link

github-actions bot commented Feb 2, 2026

Pull Request Review

Summary

This PR successfully addresses a security/privacy concern by removing references to the private website-rxiv-maker repository from public-facing documentation, in compliance with CLAUDE.md guidelines (line 338).


✅ Approval - Excellent Work

Security & Privacy

  • ✅ PASS: Successfully removes all GitHub repository references to the private website-rxiv-maker repo from public docs
  • ✅ PASS: Replacements correctly point to the deployed public website (https://rxiv-maker.henriqueslab.org)
  • ✅ PASS: Maintains user access to documentation while protecting internal repository information
  • Verification: Confirmed zero matches for website-rxiv-maker in CHANGELOG.md and docs/ECOSYSTEM.md after changes

Code Quality

  • ✅ PASS: Changes are minimal, focused, and surgical - only what's necessary
  • ✅ PASS: Consistent replacement strategy across files (private repo → public website)
  • ✅ PASS: No functional changes - documentation links remain valid
  • ✅ PASS: Follows principle of least privilege

Documentation Quality

  • ✅ EXCELLENT: Added HOMEBREW_FORMULA_TEMPLATE.md - Standardizes Homebrew documentation across HenriquesLab repos
  • ✅ EXCELLENT: Added HOMEBREW_DOCS_CHECKLIST.md - Provides actionable review checklist for consistency
  • ✅ PASS: Templates use proper placeholders (PACKAGE_NAME, VERSION=X.Y.Z) instead of hardcoded values
  • ✅ PASS: Templates promote automated workflow (just release) as primary method
  • ✅ PASS: Templates are well-structured with good/bad examples

Changes Breakdown

CHANGELOG.md (2 changes)

  • Line 1160: website-rxiv-makerofficial documentation website
  • Line 1163: Removed from ecosystem list

docs/ECOSYSTEM.md (4 changes)

  • Line 39: Mermaid diagram node updated to "Documentation Website"
  • Line 75: Repository table entry now references deployed website
  • Line 257: Release workflow diagram reference updated
  • Line 441: Technical stats table updated to show deployed site

New Files (Bonus Value)

  • docs/HOMEBREW_FORMULA_TEMPLATE.md: Comprehensive template for Homebrew docs
  • docs/HOMEBREW_DOCS_CHECKLIST.md: Review checklist for consistency

Testing & Validation

  • ✅ PASS: No code changes - zero risk of introducing bugs
  • ✅ PASS: Documentation-only changes - no functional impact
  • ✅ PASS: Links remain valid (public website is live)
  • ✅ PASS: No test files affected (verified with grep)

Alignment with Project Standards

  • ✅ PASS: Follows CLAUDE.md security guidelines explicitly
  • ✅ PASS: Complies with "Security by Design" principle
  • ✅ PASS: Pre-commit hooks passed (noted in PR description)
  • ✅ PASS: No broken links

What's Particularly Good

  1. Security awareness: Proactively identified and fixed a security/privacy issue
  2. Thoroughness: Found all 6 references across 2 files
  3. Consistency: Replaced all references with the same public alternative
  4. Added value: Bonus documentation templates that benefit the entire HenriquesLab ecosystem
  5. Clear PR description: Well-documented with before/after, verification steps, and rationale

Recommendations

Minor Suggestions (Optional)

  1. Consider updating .lycheeignore comment: Line 34 in .lycheeignore has a comment "Private repositories (if any)" followed by the website-rxiv-maker URL. While this is appropriate (link checker should ignore it), the comment could be more explicit:

    # Private repositories (do not check - not publicly accessible)
    https://github.com/HenriquesLab/website-rxiv-maker
    
  2. Template maintainability: The new templates reference PR numbers (rxiv-maker docs: align Homebrew formula workflow with CLAUDE.md automation #280, folder2md4llms fix: improve mathematical expression handling in code spans #37, TaskRepo Added colab notebook with G'Drive support #12). Consider if these should link to the actual PRs for future reference, though current format is acceptable.

No Action Required On

  • CLAUDE.md: Correctly retains website-rxiv-maker references (internal maintainer file - appropriate)
  • Test coverage: No tests affected (documentation-only changes)
  • Backwards compatibility: N/A (documentation changes only)

Conclusion

LGTM - Ready to Merge 🚀

This PR successfully addresses the security concern while adding valuable documentation infrastructure. The changes are:

  • Low risk: Documentation-only, no code modifications
  • High value: Removes private repo exposure + adds ecosystem documentation standards
  • Well-executed: Thorough, consistent, and properly verified

Excellent work identifying and resolving this security gap in the public documentation!


Priority: High (Security/Privacy) ✅
Risk: Low (Documentation-only) ✅
Quality: Excellent ✅
Recommendation: Approve and Merge

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR aims to remove references to the private website-rxiv-maker GitHub repository from public documentation files, in compliance with the CLAUDE.md security guidelines that explicitly prohibit referencing this private repository in public documentation.

Changes:

  • Updated CHANGELOG.md to replace private repository references with public website URL
  • Updated docs/ECOSYSTEM.md mermaid diagrams and tables to reference the deployed documentation website instead of the private repository
  • Added two new Homebrew formula documentation template files (unrelated to security fix)

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.

File Description
CHANGELOG.md Replaced private website-rxiv-maker repository links with public website URL (https://rxiv-maker.henriqueslab.org) in lines 1160 and 1163
docs/ECOSYSTEM.md Updated mermaid diagrams and tables to reference "Documentation Website" instead of private repository name
docs/HOMEBREW_FORMULA_TEMPLATE.md NEW FILE: Homebrew formula update template (unrelated to stated security fix)
docs/HOMEBREW_DOCS_CHECKLIST.md NEW FILE: Homebrew documentation review checklist (unrelated to stated security fix)

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@@ -0,0 +1,198 @@
# Homebrew Formula Update Template
Copy link

Copilot AI Feb 2, 2026

Choose a reason for hiding this comment

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

This PR includes two entirely new files (HOMEBREW_FORMULA_TEMPLATE.md and HOMEBREW_DOCS_CHECKLIST.md) that are not mentioned in the PR description and appear to be unrelated to the stated security fix objective of removing private repository references. These files are about Homebrew formula documentation templates and should either be:

  1. Removed from this PR and submitted as a separate PR focused on Homebrew documentation, or
  2. Added to the PR description to explain why they're included in a security-focused PR

Copilot uses AI. Check for mistakes.
- New utility commands are added to homebrew-formulas
- Common issues or best practices are identified

**Last updated:** 2026-02-02 (aligned with rxiv-maker PR #280, folder2md4llms PR #37, TaskRepo PR #12)
Copy link

Copilot AI Feb 2, 2026

Choose a reason for hiding this comment

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

This file references "rxiv-maker PR #280" but this appears to be a circular reference if this IS PR #280. The PR number should either be corrected to reference the actual PR that established these templates, or this line should be removed/updated to avoid confusion. Additionally, this entire file appears unrelated to the security fix described in the PR title and description.

Suggested change
**Last updated:** 2026-02-02 (aligned with rxiv-maker PR #280, folder2md4llms PR #37, TaskRepo PR #12)
**Last updated:** 2026-02-02 (aligned with current Homebrew automation workflows across related repositories)

Copilot uses AI. Check for mistakes.
## Related PRs

Template established and applied in:
- **rxiv-maker**: PR #280
Copy link

Copilot AI Feb 2, 2026

Choose a reason for hiding this comment

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

This file references "rxiv-maker: PR #280" in the "Related PRs" section, which appears to be a circular reference if this IS PR #280. The PR number should be corrected or this line should indicate the PR is pending/in-progress rather than completed.

Suggested change
- **rxiv-maker**: PR #280
- **rxiv-maker**: this PR (template introduction)

Copilot uses AI. Check for mistakes.
@paxcalpt paxcalpt merged commit eb5c42f into main Feb 2, 2026
8 checks passed
@paxcalpt paxcalpt deleted the fix/remove-private-repo-references branch February 2, 2026 11:22
paxcalpt added a commit that referenced this pull request Feb 2, 2026
This patch release focuses on documentation improvements and security compliance:

Documentation:
- Align Homebrew formula workflow with CLAUDE.md automation (#280)
- Add standardized Homebrew documentation templates (#281)
- Prioritize just-based automation across ecosystem

Security:
- Remove private repository references from public docs (#282)
- Comply with CLAUDE.md security guidelines

Affects: CONTRIBUTING.md, README.md, CHANGELOG.md, docs/ECOSYSTEM.md

Co-Authored-By: Claude Sonnet 4.5 <[email protected]>
@paxcalpt paxcalpt mentioned this pull request Feb 2, 2026
paxcalpt added a commit that referenced this pull request Feb 2, 2026
This patch release focuses on documentation improvements and security compliance:

Documentation:
- Align Homebrew formula workflow with CLAUDE.md automation (#280)
- Add standardized Homebrew documentation templates (#281)
- Prioritize just-based automation across ecosystem

Security:
- Remove private repository references from public docs (#282)
- Comply with CLAUDE.md security guidelines

Affects: CONTRIBUTING.md, README.md, CHANGELOG.md, docs/ECOSYSTEM.md

Co-authored-by: Claude Sonnet 4.5 <[email protected]>
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.

2 participants