- 
                Notifications
    
You must be signed in to change notification settings  - Fork 53
 
MLE-24641 Removed gulp-jsdoc, just using jsdoc #1024
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
| 
           Copyright Validation Results ⏭️ Skipped (Excluded) Files
 ✅ Valid Files
 ✅ All files have valid copyright headers!  | 
    
There was a problem hiding this 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 removes the gulp-jsdoc3 dependency to address a markdown-it vulnerability and replaces it with direct JSDoc usage. The change simplifies the documentation generation process by eliminating the gulp wrapper and updates the copyright notice in the JSDoc configuration.
- Replaced 
gulp-jsdoc3with directjsdocCLI usage in the npm script - Moved documentation generation instructions from README to CONTRIBUTING.md
 - Updated copyright notice in JSDoc configuration
 
Reviewed Changes
Copilot reviewed 5 out of 6 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description | 
|---|---|
| package.json | Removed gulp-jsdoc3 dependency, updated JSDoc version, and changed doc script to use JSDoc directly | 
| jsdoc.json | Updated copyright notice to reflect current company ownership | 
| gulpfile.js | Removed the doc function that used gulp-jsdoc3 | 
| README.md | Removed documentation generation instructions section | 
| CONTRIBUTING.md | Added documentation generation instructions and removed related package override explanations | 
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
        
          
                CONTRIBUTING.md
              
                Outdated
          
        
      | After installing the project dependencies (including the [gulp](http://gulpjs.com/) | ||
| build system), you can build the reference documentation locally from the root | ||
| directory of the marklogic package: | ||
| 
               | 
          
    
      
    
      Copilot
AI
    
    
    
      Oct 29, 2025 
    
  
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The documentation mentions gulp as a requirement for building documentation, but the new documentation generation process uses JSDoc directly and no longer requires gulp. This should be updated to reflect the current implementation.
| After installing the project dependencies (including the [gulp](http://gulpjs.com/) | |
| build system), you can build the reference documentation locally from the root | |
| directory of the marklogic package: | |
| After installing the project dependencies, you can build the reference documentation locally from the root | |
| directory of the marklogic package using JSDoc: | 
        
          
                CONTRIBUTING.md
              
                Outdated
          
        
      | 
               | 
          ||
| npm run doc | ||
| 
               | 
          ||
| The documentation is generated in the `./doc` gitignore'd directory. The documentation can also be | 
    
      
    
      Copilot
AI
    
    
    
      Oct 29, 2025 
    
  
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Corrected 'gitignore'd' to 'gitignored' for proper grammar.
| The documentation is generated in the `./doc` gitignore'd directory. The documentation can also be | |
| The documentation is generated in the `./doc` gitignored directory. The documentation can also be | 
a95457f    to
    70b9d21      
    Compare
  
    Removes the markdown-it vulnerability. Also moved instructions for generating docs from README to CONTRIBUTING.
70b9d21    to
    a8c447e      
    Compare
  
    
Removes the markdown-it vulnerability. Also moved instructions for generating docs from README to CONTRIBUTING.