docs(npm): add consistent README to published packages#2246
docs(npm): add consistent README to published packages#2246spike-rabbit wants to merge 1 commit into
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request standardizes the README files across all sub-projects to a minimal layout that directs users to the central documentation site (element.siemens.io). In addition, the build scripts in package.json have been updated to copy only the LICENSE.md file to the distribution directories, omitting the README.md files. There are no review comments, and I have no feedback to provide.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
spike-rabbit
force-pushed
the
docs/npm-package-readmes
branch
2 times, most recently
from
d77249d to
e0793ee
Compare
timowolf
left a comment
timowolf
left a comment
There was a problem hiding this comment.
I would stick to markdown syntax as much as possible and also I would not delete the documentation. This is what developers expect when getting into the readme.
spike-rabbit
force-pushed
the
docs/npm-package-readmes
branch
from
e0793ee to
73f730e
Compare
spike-rabbit
force-pushed
the
docs/npm-package-readmes
branch
from
73f730e to
fdc81a5
Compare
|
We should have our docs in one place: I will clean up the docs first, as I was not aware how many things are currently hidden in README files. |
2 participants
Summary
Adds a consistent, minimal
README.mdto every package published to npm. Each one shows the Element icon, the package name as title, and a call to action linking to https://element.siemens.io.Affected published packages:
@siemens/charts-ng@siemens/dashboards-ng@siemens/element-ng@siemens/element-theme@siemens/element-translate-cli@siemens/element-translate-ng@siemens/live-preview@siemens/maps-ng@siemens/native-charts-ngBuild script cleanup
lib:buildpreviously copied the repository rootREADME.mdover the package-specific one forelement-ng; it now copies onlyLICENSE.md.README.mdcopy steps fromcharts:buildandmaps:build.ng-packagr already copies each project's own
README.mdinto itsdist/@siemens/*output, and the two source-published packages (element-theme,element-translate-cli) include their README automatically via npm packaging.Verification
element-ng,charts-ng, anddashboards-ngconfirm the correct per-package README lands indist, withLICENSE.mdstill present.npm pack --dry-runconfirmsREADME.mdis included for the source-published packages.Documentation.
Examples.
Dashboards Demo.
Playwright report.
Coverage Reports: