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

chore: Write README for all packages except tokens #1670

Merged
merged 18 commits into from
Oct 23, 2024

Conversation

VincentSmedinga
Copy link
Contributor

@VincentSmedinga VincentSmedinga commented Oct 17, 2024

Describe the pull request

What

This is a continuation of #1655 to improve the general documentation of all our packages.

It also removes mentions of Salesforce, as we no longer aim to replicate our components for it. I’ve removed more ‘future plans’ and ‘roadmaps’ as they easily get outdated.

Why

To help people understand what we offer and how they can use it.

How

Adds or updates the README and some fields in package.json for the assets, css, react, and react-icons packages.

The sections headings are consistently as follows, with all of them optional:

  1. About
  2. Motivation
  3. Installation
  4. Usage
  5. Updating
  6. Support

Checklist

Before submitting your pull request, please ensure you have done the following. Check each checkmark if you have done so or if it wasn't necessary:

  • Add or update unit tests
  • Add or update documentation
  • Add or update stories
  • Add or update exports in index.* files
  • Start the PR title with a Conventional Commit prefix, as explained here.

Additional notes

  • Provide links to any related issues or discussions.
  • Add a link to the specific story in the feature branch deploy.
  • Mention any areas where additional review or feedback is needed.

packages/css/README.md Show resolved Hide resolved
packages/css/README.md Show resolved Hide resolved
packages/css/README.md Outdated Show resolved Hide resolved
packages/react/README.md Show resolved Hide resolved
proprietary/react-icons/README.md Outdated Show resolved Hide resolved
proprietary/react-icons/README.md Outdated Show resolved Hide resolved
proprietary/react-icons/README.md Outdated Show resolved Hide resolved
storybook/package.json Outdated Show resolved Hide resolved
@github-actions github-actions bot temporarily deployed to demo-DES-982-other-packages-readmes October 21, 2024 13:51 Destroyed
packages/css/README.md Show resolved Hide resolved
packages/css/README.md Show resolved Hide resolved
packages/css/README.md Outdated Show resolved Hide resolved
packages/css/README.md Outdated Show resolved Hide resolved
packages/react/README.md Show resolved Hide resolved
proprietary/react-icons/README.md Outdated Show resolved Hide resolved
storybook/package.json Outdated Show resolved Hide resolved
@github-actions github-actions bot temporarily deployed to demo-DES-982-other-packages-readmes October 21, 2024 13:53 Destroyed
@github-actions github-actions bot temporarily deployed to demo-DES-982-other-packages-readmes October 21, 2024 13:58 Destroyed
packages/css/README.md Show resolved Hide resolved
packages/css/README.md Outdated Show resolved Hide resolved
proprietary/react-icons/README.md Outdated Show resolved Hide resolved
packages/react/README.md Outdated Show resolved Hide resolved
@github-actions github-actions bot temporarily deployed to demo-DES-982-other-packages-readmes October 23, 2024 09:04 Destroyed
@github-actions github-actions bot temporarily deployed to demo-DES-982-other-packages-readmes October 23, 2024 09:29 Destroyed
@github-actions github-actions bot temporarily deployed to demo-DES-982-other-packages-readmes October 23, 2024 09:31 Destroyed
@github-actions github-actions bot temporarily deployed to demo-DES-982-other-packages-readmes October 23, 2024 12:43 Destroyed
@alimpens alimpens merged commit 6e107a9 into develop Oct 23, 2024
6 checks passed
@alimpens alimpens deleted the feature/DES-982-other-packages-readmes branch October 23, 2024 14:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants