Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[IOAPPFD0-185] Improve io-app-design-system main README #131

Merged
merged 23 commits into from
Nov 10, 2023

Conversation

dmnplb
Copy link
Collaborator

@dmnplb dmnplb commented Nov 10, 2023

Short description

This PR improves the main README. It adds a more defined structure and reflects the page architecture of the io-app design system section.

List of changes proposed in this pull request

  • Add repo-assets folder that contains graphical assets related to the documentation
  • Update README file

How to test

  1. Go to the main repository page
  2. Preview the README after selecting this branch

@dmnplb dmnplb added the documentation Improvements or additions to documentation label Nov 10, 2023
@dmnplb dmnplb requested review from a team as code owners November 10, 2023 09:12
Copy link
Contributor

@CrisTofani CrisTofani left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A part from the requested changes, what do you think to add the badges for the current available version on NPM?

npm latest package

[![npm latest package](https://img.shields.io/npm/v/@pagopa/io-app-design-system/latest.svg)](https://www.npmjs.com/package/@pagopa/io-app-design-system)

README.md Outdated Show resolved Hide resolved
dmnplb and others added 2 commits November 10, 2023 10:46
Co-authored-by: Cristiano Tofani <cri.tofani@gmail.com>
@dmnplb
Copy link
Collaborator Author

dmnplb commented Nov 10, 2023

what do you think to add the badges for the current available version on NPM?

Just added in the commit 7e74584

@dmnplb dmnplb requested a review from CrisTofani November 10, 2023 13:33
@dmnplb dmnplb merged commit 347f552 into main Nov 10, 2023
2 checks passed
@dmnplb dmnplb deleted the IOAPPFD0-185-improve-readme branch November 10, 2023 13:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants