-
Notifications
You must be signed in to change notification settings - Fork 228
Feature chalk docs #160
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
Feature chalk docs #160
Conversation
README.md
Outdated
| Pebble.js provides the [Feature] module so that you may perform feature detection. This allows you change the presentation or behavior of your application based on the capabilities or characteristics of the current Pebble watch that the user is running your application with. | ||
|
|
||
| ### Using Feature | ||
| [Using Feature]: #feature-vs-platform |
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.
should be #using-feature, #feature-vs-platform is defined below
| Settings.option(options); | ||
| ```` | ||
|
|
||
| #### Settings.data |
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.
link
|
You seem to use links inconsistently in your section headers (I marked a bunch, not all) - not certain if intentional or not... |
|
Yes, intentional, the links are only defined if they are necessary. When the header has no strange symbols in it no anchor tag is necessary and it automatically works, but for some odd reason when there are parens or square brackets it's necessary to define your own, or possibly I've not figured out the escape sequence. |
|
Thanks for the quick look over! I updated the docs per the comments. I want to eventually add anchors for all headers, but I'm unsure if that's the right way to use Flatdoc at the moment. When I figure out more, I'll fix them all up. One of my main concerns is if I ordered the guides correctly. I kept Using Images and Using Fonts first since they're short. The two new guides are much longer, but I put the one that most users would find more immediately useful first, which I assume is Using Color. The one gotcha is that it uses |
The long awaited documentation for all the new features. All the newly introduced color fields are documented, new elements Line and Radial, and new modules Platform and Feature. Two guides are added in order to give a clearer direction for developing on Pebble.js in light of supporting Chalk.
Once everything looks good, a CloudPebble update will be requested, and this will be merged. This will address #96, #116, #156 .