Skip to content

fix(docs): restore npm run docs script and update TypeDoc configuration#5087

Open
JorgeEscire wants to merge 2 commits intoDSpace:mainfrom
JorgeEscire:Issue/5058
Open

fix(docs): restore npm run docs script and update TypeDoc configuration#5087
JorgeEscire wants to merge 2 commits intoDSpace:mainfrom
JorgeEscire:Issue/5058

Conversation

@JorgeEscire
Copy link

References
Fixes #5058

Description
The npm run docs script was missing from package.json and TypeDoc was not installed as a dependency, making it impossible to generate code documentation as described in the README. This PR restores the TypeDoc functionality by adding TypeDoc as a devDependency, adding the docs script, updating the TypeDoc configuration, and adding /doc/ to .gitignore.

Instructions for Reviewers
List of changes in this PR:

  • Added typedoc (^0.28.16) as a devDependency in package.json
  • Added "docs": "typedoc" script to package.json
  • Updated typedoc.json with modern TypeDoc 0.28+ configuration options
  • Added /doc/ to .gitignore to prevent committing generated documentation

How to test:

  1. Run npm install
  2. Run npm run docs
  3. Verify that documentation is generated in the doc/ folder
  4. Open doc/index.html in a browser to confirm the documentation renders correctly Checklist
  • My PR is created against the main branch
  • My PR is small in size
  • My PR passes ESLint validation using npm run lint
  • My PR doesn't introduce circular dependencies
  • If my PR includes new features or configurations, I've provided basic technical documentation in the PR itself

@tdonohue tdonohue added bug code task 1 APPROVAL pull request only requires a single approval to merge labels Feb 6, 2026
@tdonohue tdonohue moved this to 🙋 Needs Reviewers Assigned in DSpace 10.0 Release Feb 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

1 APPROVAL pull request only requires a single approval to merge bug code task

Projects

Status: 🙋 Needs Reviewers Assigned

Development

Successfully merging this pull request may close these issues.

Cannot generate TypeDoc documentation as described in README.md -> error Missing script "docs"

3 participants