-
Notifications
You must be signed in to change notification settings - Fork 15
Feature/button docs #45
Conversation
davidknezic
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just some wording findings. Also make sure your editor adds end lines to files.
| <h1 class="h2">{{title}}</h1> | ||
| <p> | ||
| Our buttons are based completely on the default bootstrap buttons. | ||
| </p> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Feel free to add the .lead class to the first paragraph, that usually quickly summarizes the following page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done
docs/components/buttons/index.hbs
Outdated
| <p> | ||
| This means that you can use all components provided by your favorite | ||
| platform or third party framework that are based on | ||
| bootstrap buttons and apply our styles easily. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd simplify this
This means that you can use all components provided by Bootstrap and apply our custom button styles easily.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done
docs/components/buttons/index.hbs
Outdated
| {{#*inline "content"}} | ||
| <h1 class="h2">{{title}}</h1> | ||
| <p> | ||
| Our buttons are based completely on the default bootstrap buttons. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Make sure you always capitalize Bootstrap, it's a name.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done
docs/components/buttons/index.hbs
Outdated
| </p> | ||
| <p> | ||
| The modifications are implemented in a way that should not adversely | ||
| affect other frameworks that are based |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The end of this sentence doesn't seem to match with the list that follows.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
got a bit more specific
| metadata.snippets = {} | ||
| // eslint-disable-next-line no-shadow | ||
| _.forEach((files, file) => { | ||
| _.forEach(files, (file) => { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
oh, good catch!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yea, messed up the whole snippets thing
docs/components/buttons/index.hbs
Outdated
| slug: icon-buttons | ||
| - title: AXA Button | ||
| slug: axa-buttons | ||
| - title: Ghost Button |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
After learning that only book and article titles should be capitalized and sub-titles and chapters not, this is how I'd write the chapters:
Standard button instead of Standard Button
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done
|
Requested changes implemented |
|
👍 Fixed newlines at the end of the files and set |
|
thx |
Add a first docs page about buttons to the toolkit.