docs: add missing README files to element-ng, element-theme, and element-translate-cli#1645
docs: add missing README files to element-ng, element-theme, and element-translate-cli#1645vineethwilson15 wants to merge 2 commits intosiemens:mainfrom
Conversation
…ent-translate-cli All three npm-published packages were missing README.md files, leaving their npm registry pages without documentation. Content and style aligned with existing package READMEs (charts-ng, maps-ng). Closes siemens#1050
|
Vineeth Wilson seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account. You have signed the CLA already but the status is still pending? Let us recheck it. |
![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 adds missing README.md files to three packages, which is a great improvement for discoverability on npm. The new documentation is well-structured and provides the necessary information for users to get started. I've made a few suggestions to align the content more closely with the project's UX writing style guide and to improve consistency across the new files. These changes mainly involve wording, capitalization, and adding a missing license link.
- Combine peer dependency install commands into one line - Use sentence case for section headings - Prefer 'run' over 'execute'/'executing' per UX writing guidelines - Add MIT license link to element-ng README
|
@timowolf what is your opinions about README.md in those packages? I would be in favor of going the Angular way and just include a very simple README.md linking to this repository and element.siemens.io. So just copying our root README.md everywhere would be fine. |
3 participants
Adds missing
README.mdfiles to three npm-published packages that currently showno documentation on the npm registry:
@siemens/element-ng— core component library@siemens/element-theme— SCSS theme package@siemens/element-translate-cli— translation CLI toolContent and style are aligned with existing package READMEs (
charts-ng,maps-ng,native-charts-ng). Each README covers installation, peer dependencies, basic usage,and licensing.
Closes #1050