This issue has been created
There are 3 updates.
 
 
XWiki Platform / cid:jira-generated-image-avatar-e8e08e3b-b550-48e5-b3a7-ed2b3f8e3144 XWIKI-23914 Open

Published npm packages don't feature a README.md file

 
View issue   ยท   Add comment
 

Issue created

 
cid:jira-generated-image-avatar-4259cdf7-8216-4115-b7af-62ee5088445b Manuel Leduc created this issue on 19/Jan/26 17:30
 
Summary: Published npm packages don't feature a README.md file
Issue Type: cid:jira-generated-image-avatar-e8e08e3b-b550-48e5-b3a7-ed2b3f8e3144 Bug
Affects Versions: 18.0.0-rc-1
Assignee: Unassigned
Attachments: image-2026-01-19-17-29-35-206.png
Components: Development Issues only
Created: 19/Jan/26 17:30
Priority: cid:jira-generated-image-static-major-8349ae85-28cb-4d89-94b2-f6af91f80a3c Major
Reporter: Manuel Leduc
Description:

Published npm packages don't contain a README.md file. Consequently, the package pages on npmjs.com are not really nice.
For instance, at the time of writing, the page for https://www.npmjs.com/package/@xwiki/platform-document-api looks like this:
_thumb_44511.png

This is not user-friendly, and we need to think of a way to have a README file with at least a link to our documentation.

 
 

3 updates

 
cid:jira-generated-image-avatar-4259cdf7-8216-4115-b7af-62ee5088445b Changes by Manuel Leduc on 19/Jan/26 17:30
 
Fix Version: 18.0.0
Fix Version: 18.1.0-rc-1
Assignee: Manuel Leduc