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: update root readme language #3195

Merged
merged 2 commits into from
May 30, 2020

Conversation

chrisdholt
Copy link
Member

@chrisdholt chrisdholt commented May 28, 2020

Description

This PR updates the language in the root readme to better represent the current offerings of FAST-DNA.

Issue type checklist

  • Chore: A change that does not impact distributed packages.
  • Bug fix: A change that fixes an issue, link to the issue above.
  • New feature: A change that adds functionality.

Is this a breaking change?

  • This change causes current functionality to break.

Process & policy checklist

  • I have added tests for my changes.
  • I have tested my changes.
  • I have updated the project documentation to reflect my changes.
  • I have read the CONTRIBUTING documentation and followed the standards for this project.

@chrisdholt chrisdholt force-pushed the users/chhol/update-root-readme-documentation branch from a186413 to c1ca345 Compare May 28, 2020 18:01
Copy link
Contributor

@EisenbergEffect EisenbergEffect left a comment

Choose a reason for hiding this comment

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

I like the alterations. I have some ideas for other things we can do in the readme. I'll send a link for you to look at and see if we want to incorporate anything.

@@ -24,15 +24,15 @@ There are a million and one great ways to build your next website or application
This principle of being unopinionated manifests in several important ways including:

* A flat component architecture that lets you compose what you need without struggling with rigid patterns and complex objects.
* Separating base components and style that supports multiple frameworks without re-writing or duplicating styles. This separation also lets you build your own styles, with your styling technology of choice, without having to re-build or duplicate the base components.
* Separating base components from styles and design systems to support multiple implementations without re-writing or duplicating styles. Use the design system to customize existing styled components, or build your own styles, with your design system, without having to re-build or duplicate the base components.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
* Separating base components from styles and design systems to support multiple implementations without re-writing or duplicating styles. Use the design system to customize existing styled components, or build your own styles, with your design system, without having to re-build or duplicate the base components.
* Separating base components from styles and design systems to support multiple implementations without re-writing or duplicating styles. Use the design system to customize existing styled components, or build your own styles with your design system, without having to re-build or duplicate the base components.

Copy link
Contributor

Choose a reason for hiding this comment

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

The above comma seems un-necessary but disregard if you disagree.

Copy link
Collaborator

Choose a reason for hiding this comment

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

@EisenbergEffect I merge this in so it could go with the other doc work being done over the weekend. If Chris didn't get a chance to resolve this we can do it in a future PR. I presume we'll be doing a wide edit session on all of this documentation in the future as well.

Copy link
Member Author

Choose a reason for hiding this comment

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

I didn’t see this, but we certainly should do a scrub in the future. For now I’d agree that the most important thing is accurate content. Thx for merging Aaron!

@awentzel awentzel merged commit b914c84 into master May 30, 2020
@awentzel awentzel deleted the users/chhol/update-root-readme-documentation branch May 30, 2020 15:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants