docs: updated readme files #1955

shaharzil · 2024-02-13T15:38:09Z

https://monday.monday.com/boards/3532714909/pulses/6162332067

talkor

Cool! Sorry for all these comments 😅

talkor · 2024-02-13T16:58:38Z

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,35 +1,12 @@
-<!--
+# Pull Request Template


I think it's a bit redundant and contributors will just leave it and it will be a bit weird

I still think it's a bit redundant

talkor · 2024-02-13T16:59:57Z

.github/PULL_REQUEST_TEMPLATE.md

+Thank you for contributing!
+Before we can review your submission, please fill the information below:


I think it can be commented out and also it's a bit funny to me that there's only a single checkbox. Maybe just reference the contribution guidelines in this commented-out comment?

talkor · 2024-02-13T17:00:15Z

.github/PULL_REQUEST_TEMPLATE.md


-#### Basic
+Please describe the changes you're making. Include the motivation for these changes, any additional context, and the impact on the project. If your changes are related to any open issues, please link to them here.


This can also be commented out IMO

talkor · 2024-02-13T17:00:52Z

README.md

-This functionality basically overrides the npm mapping between package name to its repo, and points it to where the package is located locally.
-
-### Troubleshooting local development
+This is a monorepo containing Vibe's maintained open-source packages.


Suggested change

This is a monorepo containing Vibe's maintained open-source packages.

This is a monorepo containing Vibe Design System open-source packages.

talkor · 2024-02-13T17:01:57Z

README.md


- If you are using NVM, make sure both packages are using the same version.
- Because we are using react hooks and having react as a peerDependency - if you want to develop locally and encounter issues with "invalid hook call" [see this github thread](https://github.com/facebook/react/issues/13991). The quick fix is in your webpack config file alias react to resolve the node_modules path
+The packages are maintained using [lerna](https://github.com/lerna/lerna/tree/master/).


I don't think it's an important information, it won't matter for users, just for contributors

Also the same for the info below. I think it would be much more informative to include a list of the packages in the monorepo with links to their README, basic "getting started" guide and how to install the main package, a title of Contributing with a link to contribution guidelines

talkor · 2024-02-13T17:05:23Z

packages/core/README.md

+## Contributing
+
+We welcome every contributor, please read the [contribution guidelines](CONTRIBUTING.md) before submitting a PR


This should move the the main

talkor · 2024-02-13T17:05:59Z

packages/core/README.md

+## Storybook
+
+We are using storybook in order to develop the components independently of any consumer.
+run this to build & run the storybook locally:
+
+```bash
+npm run storybook
+```
+
+the storybook will be served on `http://localhost:7007`
+
+## Developing locally with your consumer application
+
+When developing locally, we are using a npm functionality called npm link, this allows us to
+work locally on our package and use it in a different project without publishing.
+This functionality basically overrides the npm mapping between package name to its repo, and points it to where the package is located locally.
+
+### Troubleshooting local development
+
+- If you are using NVM, make sure both packages are using the same version.
+- Because we are using react hooks and having react as a peerDependency - if you want to develop locally and encounter issues with "invalid hook call" [see this github thread](https://github.com/facebook/react/issues/13991). The quick fix is in your webpack config file alias react to resolve the node_modules path
+
+Go to the project's directory and run:
+
+```zsh
+nvm use
+npm unlink
+npm link
+npm start
+```


This should be in the contribution guide

talkor · 2024-02-13T17:06:44Z

packages/core/README.md

+
+![image](https://user-images.githubusercontent.com/60314759/147566893-63c5209a-8b83-4f32-af61-8b4c350ec770.png)
+
+[monday.com](https://www.monday.com) React components library - [Storybook](https://style.monday.com)


This should be in the root IMO

talkor · 2024-02-13T17:07:48Z

packages/core/README.md

+| --------- | --------- | --------- | --------- | --------- | --------- |
+| last 4 versions| last 4 versions| 14+| last 2 versions| last 2 versions| last 2 versions |
+
+## Installation


This should be in the root also IMO, event though it's related to core, since core is the core of the monorepo :)

talkor · 2024-03-03T15:07:14Z

packages/core/README.md

+import "monday-ui-react-core/tokens";
+```
+
+_If your project (or it's Storybook) is importing files differently - read more [here](DEPRECATED_IMPORTS.md)._


The link will be broken

talkor

This is cool! We should be really precise here IMO as it's the face of the library, and should be as simple and easy-to-understand as possible so I wrote some more suggestions

talkor · 2024-03-17T14:50:37Z

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,35 +1,12 @@
-<!--
+# Pull Request Template


I still think it's a bit redundant

talkor · 2024-03-17T14:55:24Z

README.md

-```
-npm install monday-ui-react-core
-```
+Welcome to the Vibe Design System repository! This monorepo contains various open-source packages maintained by Vibe ([monday.com](https://www.monday.com)).


I don't think users care that it's a monorepo (beside contributors), we can call it a "project" and not a repository. Also I think it's better to rephrase is as "Vibe Design System, by monday.com), what do you think?

talkor · 2024-03-17T14:56:17Z

README.md


-Components are imported from the library's root entry:
+Vibe Design System offers a collection of packages designed to streamline your development process and enhance the user experience. Below is a list of our main packages:


Suggested change

Vibe Design System offers a collection of packages designed to streamline your development process and enhance the user experience. Below is a list of our main packages:

Vibe Design System is a collection of components and styles designed to streamline your development process and enhance the user experience. Below is a list of our main packages:

talkor · 2024-03-17T14:57:23Z

README.md

+1. [core](packages/core/README.md): [monday.com](https://www.monday.com) React components library - [Storybook](https://style.monday.com).
+2. [style](packages/style/README.md): [monday.com](https://www.monday.com) styling foundations library.


I think we should refer to Vibe here instead of monday.com, it seems repetitive, we mention in in the first paragraph

Also I don't think the internal structure is important for users at this point, it should be below "Getting Started"

talkor · 2024-03-17T14:57:39Z

README.md


-We don't import fonts ourselves, we work best with the following fonts -
-Poppins, Figtree and Roboto, we recommend adding the following `link` import to your application
+Install the component library


This seem redundant

talkor · 2024-03-17T15:00:27Z

README.md

-
-## Developing locally with your consumer application
+## Getting Started

-When developing locally, we are using a npm functionality called npm link, this allows us to
-work locally on our package and use it in a different project without publishing.
-This functionality basically overrides the npm mapping between package name to its repo, and points it to where the package is located locally.
+If you're new to Vibe Design System, we recommend starting with our main package:

-### Troubleshooting local development
+- [core](packages/core/README.md): This is the core of the Vibe Design System. Follow the installation guide and getting started instructions to integrate it into your project.


I think it's super confusing to have both sections (Installation and Getting Started), Installation can be a sub section in Getting Started with a referral to additional setup in the core README

talkor · 2024-03-17T15:01:05Z

README.md

-## Themes
-
-We support theming from the library to the component level using css variables - for more info on theming please read the [theme guidelines](THEME_README.md) file
+We welcome every contributor, please read the [contribution guidelines](packages/core/CONTRIBUTING.md) before submitting a PR


We should also add a LICENSE section here

Worth adding a sentence about feature requests and bugs (report in issues/discussions)

talkor · 2024-03-17T15:04:21Z

packages/core/README.md

+
+## Themes
+
+We support theming from the library to the component level using css variables - for more info on theming please read the [theme guidelines](./THEME_README.md) file


Suggested change

We support theming from the library to the component level using css variables - for more info on theming please read the [theme guidelines](./THEME_README.md) file

Theming is supported using CSS variables - for more info on theming please read the [theme guidelines](./THEME_README.md) file

Don't we also support ThemeProvider now?

talkor

Awesome

updated readme files

e3c1984

shaharzil requested a review from a team as a code owner February 13, 2024 15:38

shaharzil changed the title ~~updated readme files~~ docs: updated readme files Feb 13, 2024

shaharzil added 2 commits February 13, 2024 18:04

updated pr template

727122e

Merge branch 'master' into fix-readmes

562cb93

talkor reviewed Feb 13, 2024

View reviewed changes

talkor reviewed Mar 3, 2024

View reviewed changes

update readmes

0c595ff

shaharzil requested a review from talkor March 14, 2024 13:56

talkor reviewed Mar 17, 2024

View reviewed changes

talkor approved these changes Apr 2, 2024

View reviewed changes

shaharzil added 3 commits April 4, 2024 11:50

merged master

c061c58

fixed pr comments

677ea6c

fixed changes from master

20ce5c8

shaharzil merged commit e91376b into master Apr 4, 2024
10 checks passed

shaharzil deleted the fix-readmes branch April 4, 2024 10:15

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: updated readme files #1955

docs: updated readme files #1955

shaharzil commented Feb 13, 2024 •

edited

Loading

talkor left a comment

talkor Feb 13, 2024

talkor Mar 17, 2024

talkor Feb 13, 2024

talkor Feb 13, 2024

talkor Feb 13, 2024

talkor Feb 13, 2024

talkor Feb 13, 2024

talkor Feb 13, 2024

talkor Feb 13, 2024

talkor Feb 13, 2024

talkor Feb 13, 2024

talkor Mar 3, 2024

talkor left a comment

talkor Mar 17, 2024

talkor Mar 17, 2024

talkor Mar 17, 2024

talkor Mar 17, 2024

talkor Mar 17, 2024

talkor Mar 17, 2024

talkor Mar 17, 2024

talkor Mar 17, 2024

talkor Mar 17, 2024

talkor Mar 17, 2024

talkor Mar 17, 2024

talkor left a comment

		Thank you for contributing!
		Before we can review your submission, please fill the information below:


		#### Basic
		Please describe the changes you're making. Include the motivation for these changes, any additional context, and the impact on the project. If your changes are related to any open issues, please link to them here.

	This is a monorepo containing Vibe's maintained open-source packages.
	This is a monorepo containing Vibe Design System open-source packages.

		## Contributing

		We welcome every contributor, please read the [contribution guidelines](CONTRIBUTING.md) before submitting a PR


		![image](https://user-images.githubusercontent.com/60314759/147566893-63c5209a-8b83-4f32-af61-8b4c350ec770.png)

		[monday.com](https://www.monday.com) React components library - [Storybook](https://style.monday.com)


		Components are imported from the library's root entry:
		Vibe Design System offers a collection of packages designed to streamline your development process and enhance the user experience. Below is a list of our main packages:

	Vibe Design System offers a collection of packages designed to streamline your development process and enhance the user experience. Below is a list of our main packages:
	Vibe Design System is a collection of components and styles designed to streamline your development process and enhance the user experience. Below is a list of our main packages:

		1. [core](packages/core/README.md): [monday.com](https://www.monday.com) React components library - [Storybook](https://style.monday.com).
		2. [style](packages/style/README.md): [monday.com](https://www.monday.com) styling foundations library.


		## Themes

		We support theming from the library to the component level using css variables - for more info on theming please read the [theme guidelines](./THEME_README.md) file

	We support theming from the library to the component level using css variables - for more info on theming please read the [theme guidelines](./THEME_README.md) file
	Theming is supported using CSS variables - for more info on theming please read the [theme guidelines](./THEME_README.md) file

docs: updated readme files #1955

docs: updated readme files #1955

Conversation

shaharzil commented Feb 13, 2024 • edited Loading

talkor left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

talkor left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

talkor left a comment

Choose a reason for hiding this comment

shaharzil commented Feb 13, 2024 •

edited

Loading