-
-
Notifications
You must be signed in to change notification settings - Fork 41
Networking category to @nativescript/core and added the docs for the Color, Connectivity, and HTTP modules as its subcategories. #87
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
Conversation
.../core subcategories' files there.
Thank you for your pull request and welcome to our community. We require contributors to sign our Contributor License Agreement, and we don't seem to have you on file. In order for us to review and merge your code, please sign the CLA at https://www.nativescript.org/cla.
CLA has not been signed by users: @Nandee89, @Ombuweb.
After signing the CLA, you can ask me to recheck this PR by posting @cla-bot check as a comment to the PR.
....md and connectivity.md and instead made them complete,no need to point other pages
73ce845 to
469929d
Compare
Thank you for your pull request and welcome to our community. We require contributors to sign our Contributor License Agreement, and we don't seem to have you on file. In order for us to review and merge your code, please sign the CLA at https://www.nativescript.org/cla.
CLA has not been signed by users: @Nandee89, @Ombuweb.
After signing the CLA, you can ask me to recheck this PR by posting @cla-bot check as a comment to the PR.
Thank you for your pull request and welcome to our community. We require contributors to sign our Contributor License Agreement, and we don't seem to have you on file. In order for us to review and merge your code, please sign the CLA at https://www.nativescript.org/cla.
CLA has not been signed by users: @Nandee89, @Ombuweb.
After signing the CLA, you can ask me to recheck this PR by posting @cla-bot check as a comment to the PR.
Thank you for your pull request and welcome to our community. We could not parse the GitHub identity of the following contributors: Nandesora Tjihero.
This is most likely caused by a git client misconfiguration; please make sure to:
- check if your git client is configured with an email to sign commits
git config --list | grep email - If not, set it up using
git config --global user.email email@example.com - Make sure that the git commit email is configured in your GitHub account settings, see https://github.com/settings/emails
Thank you for your pull request and welcome to our community. We could not parse the GitHub identity of the following contributors: Nandesora Tjihero.
This is most likely caused by a git client misconfiguration; please make sure to:
- check if your git client is configured with an email to sign commits
git config --list | grep email - If not, set it up using
git config --global user.email email@example.com - Make sure that the git commit email is configured in your GitHub account settings, see https://github.com/settings/emails
Thank you for your pull request and welcome to our community. We could not parse the GitHub identity of the following contributors: Nandesora Tjihero.
This is most likely caused by a git client misconfiguration; please make sure to:
- check if your git client is configured with an email to sign commits
git config --list | grep email - If not, set it up using
git config --global user.email email@example.com - Make sure that the git commit email is configured in your GitHub account settings, see https://github.com/settings/emails
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 had a quick look (haven't had the chance to give this a proper read through), but this all looks great, awesome job so far!
I left a few notes where I think there's room for improvement, mainly around tabs and grouping code blocks.
I don't think we have a good reference for these features of the docs, so I'll post them here:
Types of tabs:
- Flavor tabs
- Code tabs
1. Flavor tabs
These are tabs meant to switch between different flavors (angular, vue, plain etc.) and can contain anything (notes, paragraphs, code blocks etc). They are defined as follows:
/// flavor <name>
<!-- any content here -->
///
When there are multiple flavor containers next to each other (subsequently) they are automatically grouped together.
When a user switches flavors, the choice is persisted in localStorage and updated for every flavor switcher on the page, and remembered when the user reloads the page.
2. Code tabs
These are meant to group related code blocks together, or show off a snippet in JS/TS versions.
A good example for related code blocks is when there are multiple files required for a feature... for example angular components:
'''html
<!-- the component html -->
'''
'''typescript
// the ts code for the component
'''
These would produce a html and a typescript tab.
If you need to change the tab name, you can add a comment above a code block like this:
<!-- tab: MyCustomTab Title -->
'''html
<!-- the component html -->
'''
<!-- tab: An even cooler tab -->
'''typescript
// the ts code for the component
'''
(note: in VSCode you can add these quickly with Ctrl+/ or Cmd+/ on mac and then just type tab: <name>)
If you have subsequent code blocks that you do not want to get grouped, you can separate them with an empty comment:
'''html
// ...
'''
<!-- -->
'''typescript
// ...
'''
Note I have used
'instead of a backtick in the above examples, but they should actual backticks in the docs.
nativescript-core/Application.md
Outdated
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.
We don't really need to have a flavor switcher in this case, as both of these are identical.
nativescript-core/Application.md
Outdated
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.
Removing the /// flavor X wrappers here would work, as any subsequent code-blocks will be grouped into tabs, for example (using ' instead of backticks for the example as otherwise it wouldn't render in my comment)
'''javascript
// ...
'''
'''typescript
// ...
'''
will produce a javascript/typescript tab group.
nativescript-core/Application.md
Outdated
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.
Same as previous comment about grouping subsequent code blocks into tabs (a few more places like this, will not comment on each :) )
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.
Hi @rigor789. Thank you very much for your feedback. You just taught me new stuff :). I will make the suggested changes.
Thank you for your pull request and welcome to our community. We could not parse the GitHub identity of the following contributors: Nandesora Tjihero.
This is most likely caused by a git client misconfiguration; please make sure to:
- check if your git client is configured with an email to sign commits
git config --list | grep email - If not, set it up using
git config --global user.email email@example.com - Make sure that the git commit email is configured in your GitHub account settings, see https://github.com/settings/emails
Thank you for your pull request and welcome to our community. We could not parse the GitHub identity of the following contributors: Nandesora Tjihero.
This is most likely caused by a git client misconfiguration; please make sure to:
- check if your git client is configured with an email to sign commits
git config --list | grep email - If not, set it up using
git config --global user.email email@example.com - Make sure that the git commit email is configured in your GitHub account settings, see https://github.com/settings/emails
Thank you for your pull request and welcome to our community. We could not parse the GitHub identity of the following contributors: Nandesora Tjihero.
This is most likely caused by a git client misconfiguration; please make sure to:
- check if your git client is configured with an email to sign commits
git config --list | grep email - If not, set it up using
git config --global user.email email@example.com - Make sure that the git commit email is configured in your GitHub account settings, see https://github.com/settings/emails
Thank you for your pull request and welcome to our community. We could not parse the GitHub identity of the following contributors: Nandesora Tjihero.
This is most likely caused by a git client misconfiguration; please make sure to:
- check if your git client is configured with an email to sign commits
git config --list | grep email - If not, set it up using
git config --global user.email email@example.com - Make sure that the git commit email is configured in your GitHub account settings, see https://github.com/settings/emails
Thank you for your pull request and welcome to our community. We could not parse the GitHub identity of the following contributors: Nandesora Tjihero.
This is most likely caused by a git client misconfiguration; please make sure to:
- check if your git client is configured with an email to sign commits
git config --list | grep email - If not, set it up using
git config --global user.email email@example.com - Make sure that the git commit email is configured in your GitHub account settings, see https://github.com/settings/emails
Thank you for your pull request and welcome to our community. We could not parse the GitHub identity of the following contributors: Nandesora Tjihero.
This is most likely caused by a git client misconfiguration; please make sure to:
- check if your git client is configured with an email to sign commits
git config --list | grep email - If not, set it up using
git config --global user.email email@example.com - Make sure that the git commit email is configured in your GitHub account settings, see https://github.com/settings/emails
Thank you for your pull request and welcome to our community. We could not parse the GitHub identity of the following contributors: Nandesora Tjihero.
This is most likely caused by a git client misconfiguration; please make sure to:
- check if your git client is configured with an email to sign commits
git config --list | grep email - If not, set it up using
git config --global user.email email@example.com - Make sure that the git commit email is configured in your GitHub account settings, see https://github.com/settings/emails
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.
Since there's a plan to drop @nativescript/theme and mainly support @nativescript/tailwind, I think it's better to mention @nativescript/tailwind here. Not sure if it provides all CSS to {N} though, or just a subset.
Thank you for your pull request and welcome to our community. We could not parse the GitHub identity of the following contributors: Nandesora Tjihero.
This is most likely caused by a git client misconfiguration; please make sure to:
- check if your git client is configured with an email to sign commits
git config --list | grep email - If not, set it up using
git config --global user.email email@example.com - Make sure that the git commit email is configured in your GitHub account settings, see https://github.com/settings/emails
Thank you for your pull request and welcome to our community. We could not parse the GitHub identity of the following contributors: Nandesora Tjihero.
This is most likely caused by a git client misconfiguration; please make sure to:
- check if your git client is configured with an email to sign commits
git config --list | grep email - If not, set it up using
git config --global user.email email@example.com - Make sure that the git commit email is configured in your GitHub account settings, see https://github.com/settings/emails
Thank you for your pull request and welcome to our community. We could not parse the GitHub identity of the following contributors: Nandesora Tjihero.
This is most likely caused by a git client misconfiguration; please make sure to:
- check if your git client is configured with an email to sign commits
git config --list | grep email - If not, set it up using
git config --global user.email email@example.com - Make sure that the git commit email is configured in your GitHub account settings, see https://github.com/settings/emails
Thank you for your pull request and welcome to our community. We could not parse the GitHub identity of the following contributors: Nandesora Tjihero.
This is most likely caused by a git client misconfiguration; please make sure to:
- check if your git client is configured with an email to sign commits
git config --list | grep email - If not, set it up using
git config --global user.email email@example.com - Make sure that the git commit email is configured in your GitHub account settings, see https://github.com/settings/emails
Thank you for your pull request and welcome to our community. We could not parse the GitHub identity of the following contributors: Nandesora Tjihero.
This is most likely caused by a git client misconfiguration; please make sure to:
- check if your git client is configured with an email to sign commits
git config --list | grep email - If not, set it up using
git config --global user.email email@example.com - Make sure that the git commit email is configured in your GitHub account settings, see https://github.com/settings/emails
Thank you for your pull request and welcome to our community. We could not parse the GitHub identity of the following contributors: Nandesora Tjihero.
This is most likely caused by a git client misconfiguration; please make sure to:
- check if your git client is configured with an email to sign commits
git config --list | grep email - If not, set it up using
git config --global user.email email@example.com - Make sure that the git commit email is configured in your GitHub account settings, see https://github.com/settings/emails
Thank you for your pull request and welcome to our community. We could not parse the GitHub identity of the following contributors: Nandesora Tjihero.
This is most likely caused by a git client misconfiguration; please make sure to:
- check if your git client is configured with an email to sign commits
git config --list | grep email - If not, set it up using
git config --global user.email email@example.com - Make sure that the git commit email is configured in your GitHub account settings, see https://github.com/settings/emails
Thank you for your pull request and welcome to our community. We could not parse the GitHub identity of the following contributors: Nandesora Tjihero.
This is most likely caused by a git client misconfiguration; please make sure to:
- check if your git client is configured with an email to sign commits
git config --list | grep email - If not, set it up using
git config --global user.email email@example.com - Make sure that the git commit email is configured in your GitHub account settings, see https://github.com/settings/emails
Other subcategories docs are in progress