Skip to content

Commit 7a45391

Browse files
committed
chore: intro cleanup and npm package doc notes
1 parent ac7baed commit 7a45391

File tree

2 files changed

+27
-13
lines changed

2 files changed

+27
-13
lines changed

introduction.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,15 @@ The docs have been written with no assumtions of the readers experience, however
1818
- [Introduction to JavaScript](https://developer.mozilla.org/en-US/docs/Web/JavaScript)
1919
- [Re-Introduction to JavaScript to refresh your knowledge](https://developer.mozilla.org/en-US/docs/Web/JavaScript/A_re-introduction_to_JavaScript)
2020

21-
## Templates
21+
## [Environment Setup](environment-setup)
22+
23+
You will want to setup your development machine using the [Environment Setup guide here](environment-setup) which involves preparing your machine for iOS and Android development as well as installing the [NativeScript CLI](https://www.npmjs.com/package/nativescript) via `npm install -g nativescript`
24+
25+
## Overview of NativeScript development
26+
27+
:::warning Note
28+
The following is a general overview of NativeScript development. To try any of the commands mentioned be sure you have a proper environment setup first.
29+
:::
2230

2331
NativeScript allows scaffolding projects with various templates to kickstart your app development. Official templates can be found in the [Templates GitHub repository](https://github.com/NativeScript/nativescript-app-templates/tree/master/packages) and on [NPM](https://www.npmjs.com/search?q=%40nativescript%20template).
2432

@@ -372,9 +380,3 @@ NavigationButton {
372380
- [Read JavaScript App Template Style Guide](https://github.com/NativeScript/nativescript-starter-kits-utils/blob/master/docs/style-guide-app-template.md)
373381

374382
- [Read Angular App Template Style Guide](https://github.com/NativeScript/nativescript-starter-kits-utils/blob/master/docs/style-guide-app-template-ng.md)
375-
376-
## Versioning Scheme
377-
378-
`@nativescript/core` does not follow Semantic Versioning. Major framework releases are released every six months (~March and ~September), while minor and patch releases may be released as often as every week. Patch releases should never contain breaking changes, however minor, and major releases can. We strive to note any breaking changes in the Changelogs, to make upgrades as easy as possible.
379-
380-
When referencing the `@nativescript/core` package, you should use a fixed version constraint such as `7.0.11`, or alternatively `~7.0.11` to allow installing patch updates.

understanding-packages.md

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,30 +2,42 @@
22
title: Understanding @nativescript
33
---
44

5-
There are a few npm packages that are fundamental to NativeScript development and are good to understand.
5+
There are a few npm packages that are fundamental to NativeScript development and good to understand.
66

7-
### `@nativescript/core`
7+
### [@nativescript/core](https://www.npmjs.com/package/@nativescript/core)
88

99
A JavaScript library providing an easy to use api for interacting with iOS and Android platform APIs.
1010

11-
### `@nativescript/android`
11+
### [@nativescript/android](https://www.npmjs.com/package/@nativescript/android)
1212

1313
The v8 JavaScript engine runtime enabled for Android NativeScript development.
1414

15-
### `@nativescript/ios`
15+
### [@nativescript/ios](https://www.npmjs.com/package/@nativescript/ios)
1616

1717
The v8 JavaScript engine runtime enabled for iOS NativeScript development.
1818

1919
You can also use a [JavaScriptCore](https://developer.apple.com/documentation/javascriptcore) version of this runtime using the npm tag `JSC`. This can be useful for projects that may experience any issue with the v8 engine.
2020

21-
### `@nativescript/types`
21+
### [@nativescript/types](https://www.npmjs.com/package/@nativescript/types)
2222

2323
This provides TypeScript definitions for all iOS and Android APIs available to do NativeScript development with.
2424

25-
### `@nativescript/webpack`
25+
### [@nativescript/webpack](https://www.npmjs.com/package/@nativescript/webpack)
2626

2727
This provides loaders, helpers and base configs for all fundamental NativeScript development to debug, run, build and release your apps.
2828

29+
### [nativescript](https://www.npmjs.com/package/nativescript)
30+
31+
CLI (Command Line Interface) used for creating/running/building/deploying NativeScript apps. Often installed globally along with a proper [Environment Setup](environment-setup) via `npm install -g nativescript`.
32+
2933
## Plugins
3034

3135
There are also quite a number of plugins maintained and developed by the NativeScript TSC which you can find [documented here](plugins/index)
36+
37+
## NPM Versioning
38+
39+
NativeScript packages do not follow Semantic Versioning for a particular reason. Since NativeScript enables the empowerment of JavaScript with native platform APIs we strive to do major releases around platform API tooling upgrade cycles (Things like Xcode, Android Studio, etc.). Major framework releases are generally released every six months (~March and ~September which is often the timeframe platform API toolchains are also updated), while minor and patch releases may be released as often as every week. Patch releases should never contain breaking changes, however minor, and major releases can. We strive to note any breaking changes in the Changelogs, to make upgrades as easy as possible.
40+
41+
We always recommend using `~` (tilda) with any NativeScript package versions in your projects as that will ensure anytime you execute a `ns clean` against your project that the next run will pull down the latest patch release fixes to anything we may have released.
42+
43+
For example, when referencing the `@nativescript/core` package, you could use a fixed version constraint such as `8.0.0`, or alternatively `~8.0.0` to allow installing patch updates automatically after a project clean.

0 commit comments

Comments
 (0)