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

Create demos for nature components #666

Merged
merged 18 commits into from
Feb 1, 2022
Merged

Create demos for nature components #666

merged 18 commits into from
Feb 1, 2022

Conversation

alexkilgour
Copy link
Collaborator

@alexkilgour alexkilgour commented Jan 24, 2022

Components done:

  • nature-footer
  • nature-header
  • nature-hero
  • nature-section-heading
  • nature-sort-by

NOTE On nature-header the protocol relative URLs have been removed as they are now an antipattern and they also break the demos

Future work

A number of improvements have been identified in these components, and some areas that need more thought. These have been collected in the following issues - #667 #668 #669 #670 #671

Copy link
Contributor

@amyhupe amyhupe left a comment

Choose a reason for hiding this comment

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

Hi Alex, a few suggestions, comments and a couple of questions for you here. Hope all makes sense.

toolkits/nature/packages/nature-footer/README.md Outdated Show resolved Hide resolved
toolkits/nature/packages/nature-footer/demo/context.json Outdated Show resolved Hide resolved
toolkits/nature/packages/nature-footer/demo/context.json Outdated Show resolved Hide resolved
toolkits/nature/packages/nature-hero/README.md Outdated Show resolved Hide resolved
toolkits/nature/packages/nature-header/README.md Outdated Show resolved Hide resolved
toolkits/nature/packages/nature-header/README.md Outdated Show resolved Hide resolved
@@ -37,6 +39,8 @@ To use the Section heading component, enter the following command in your Termin
npm install @springernature/nature-section-heading
```

## Usage
Copy link
Contributor

Choose a reason for hiding this comment

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

Is this different from installation?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yes. The installation is just that single line, then this details how you use it in your product. It is a common readme format used across open source projects.

toolkits/nature/packages/nature-sort-by/README.md Outdated Show resolved Hide resolved
@alexkilgour alexkilgour marked this pull request as ready for review January 31, 2022 14:17
@alexkilgour alexkilgour merged commit 7113be6 into master Feb 1, 2022
@alexkilgour alexkilgour deleted the naturedemos branch February 1, 2022 14:23
sturobson pushed a commit that referenced this pull request Feb 2, 2022
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.

3 participants