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.

Sign up for GitHub

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

Jump to bottom

Components: reconcile multiple README and CONTRIBUTING into single docs #34692

Closed
3 tasks
Tracked by #34304
ciampo opened this issue Sep 9, 2021 · 4 comments
Closed
3 tasks
Tracked by #34304

Components: reconcile multiple README and CONTRIBUTING into single docs #34692

ciampo opened this issue Sep 9, 2021 · 4 comments
Assignees
@ciampo @chad1008
Labels
[Feature] Component System WordPress component system [Package] Components /packages/components [Type] Developer Documentation Documentation for developers

Comments

@ciampo
Copy link
Contributor

ciampo commented Sep 9, 2021 •
edited
Loading

What

Follow up to #33960 — There are currently multiple README and CONTRIBUTING files in the @wordpress/components package — we should reconcile them into single files.

Why

Keeping our docs clear and up-to-date

A/C

  • Only one README and one CONTRIBUTING file should be present at the root of the package
  • Information should be consolidated within the same doc(s)
  • Out-of-date information should be removed
@ciampo ciampo mentioned this issue Sep 9, 2021
Open
10 tasks
@ciampo ciampo self-assigned this Sep 9, 2021
@ciampo ciampo added [Feature] Component System WordPress component system [Package] Components /packages/components [Type] Developer Documentation Documentation for developers labels Sep 9, 2021
@ryanwelcher
Copy link
Contributor

@ciampo is this issue still relevant?

@ciampo
Copy link
Contributor Author

ciampo commented Apr 11, 2023

Hey @ryanwelcher , yes it is. I'll see if we squeeze in some time to work on this in the upcoming days

@ciampo
Copy link
Contributor Author

ciampo commented Apr 27, 2023

cc @chad1008 — we talked about this task recently, here's the related open issue

@chad1008 chad1008 self-assigned this Apr 27, 2023
@ciampo
Copy link
Contributor Author

ciampo commented May 5, 2023

Closing as solved by #50226

@ciampo ciampo closed this as completed May 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ciampo ciampo

@chad1008 chad1008

Labels
[Feature] Component System WordPress component system [Package] Components /packages/components [Type] Developer Documentation Documentation for developers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@ciampo @ryanwelcher @chad1008