Skip to content

Few README.md updates - #6181

Open
MMilosz wants to merge 4 commits into
DSpace:mainfrom
MMilosz:docs/readme/few-updates
Open

Few README.md updates#6181
MMilosz wants to merge 4 commits into
DSpace:mainfrom
MMilosz:docs/readme/few-updates

Conversation

@MMilosz

@MMilosz MMilosz commented Sep 4, 2026

Copy link
Copy Markdown
Contributor

References

None

Description

Few maintenance updates to README documentation. Changes reflected in commit history.

Note: the README would benefit from a more thorough re-visit

Changes

  • Updated ToC (removed nonexisting #deploy, renamed #collaborating -> #contributing, added missing headers)
  • Unit/E2E Tests section: replaced npm run coverage (it does not exist) with npm run test:headless and npm run test:watch, updated Cypress extension .spec.ts -> .cy.ts
  • Other commands section: removed paragraph about pre or post scripts (pree2e, prebuild etc. were used before 2021, see: 71f5b46), added info on npm run & npm run <script-name>
  • File Tree section: added some relevant files, fixed some entries
  • Editor/IDE section: removed deprecated 'Debugger for Chrome' (it's now built natively into VS Code)
  • FAQ section: removed 'node-pre-gyp ERR in npm install' (python 2 has been deprecated for years, also the official Node.js for Windows installer now automatically installs the required tools)
  • Converted Docker production warning to Markdown Alert format for visibility
  • Some typos corrections, minor grammar changes, http->https, URL updates, etc.

Instructions for Reviewers

No functional changes. Review changes in README.md

Checklist

Note: I've checked all items in the checklist as this is a documentation-only update, so code-related items do not apply.

  • My PR is created against the main branch of code (unless it is a backport or is fixing an issue specific to an older branch).
  • My PR is small in size (e.g. less than 1,000 lines of code, not including comments & specs/tests), or I have provided reasons as to why that's not possible.
  • My PR follows all coding best practices based on the Code Conventions Guide
  • My PR passes ESLint validation using npm run lint
  • My PR doesn't introduce circular dependencies (verified via npm run check-circ-deps)
  • My PR includes TypeDoc comments for all new (or modified) public methods and classes. It also includes TypeDoc for large or complex private methods.
  • My PR passes all specs/tests and includes new/updated specs or tests based on the Code Testing Guide.
  • My PR aligns with Accessibility guidelines if it makes changes to the user interface.
  • My PR uses i18n (internationalization) keys instead of hardcoded English text, to allow for translations.
  • My PR includes details on how to test it. I've provided clear instructions to reviewers on how to successfully test this fix or feature.
  • If my PR includes new libraries/dependencies (in package.json), I've made sure their licenses align with the DSpace BSD License based on the Licensing of Contributions documentation.
  • If my PR includes new features or configurations, I've provided basic technical documentation in the PR itself.
  • If my PR fixes an issue ticket, I've linked them together.

- remove nonexisting #deploy
- rename #collaborating -> #contributing
- add missing sections
- `npm run coverage` does not exist, replace with `npm run test: headless` and `npm run test:watch`
- update E2E extension `.spec.ts` -> `.cy.ts`
- minor grammar changes
- delete paragraph about `pre` or `post` scripts to reflect current package.json state
- mention `npm run` can be used to see the available scripts
- mention `npm run <script-name>`
- use Markdown Alert in 'Running the application with Docker'
- remove deprecated 'Debugger for Chrome' under 'Visual Studio Code' (it's now built natively into VS Code)
- mention .editorconfig under 'Recommended Editors/IDEs'
- mention more relevant files in 'File Structure', also fix some entries that doesn't exist or use different name, also update http->https
- in FAQ, remove 'node-pre-gyp ERR in npm install'
  - python 2 has been deprecated for years
  - official Node.js for Windows installer now automatically installs the required tools
- minor changes (Typescript -> TypeScript, TYPEDOC -> TypeDoc, --save-dev -> --save-dev, etc.)
@MMilosz
MMilosz marked this pull request as ready for review September 4, 2026 14:05
@lgeggleston lgeggleston added 1 APPROVAL pull request only requires a single approval to merge documentation Ticket describes improvements or additions to documentation labels Sep 4, 2026
@lgeggleston lgeggleston moved this to 🙋 Needs Reviewers Assigned in DSpace 11.0 Release Sep 4, 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 documentation Ticket describes improvements or additions to documentation

Projects

Status: 🙋 Needs Reviewers Assigned

Development

Successfully merging this pull request may close these issues.

2 participants