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

[preview] First round of major dev guide revisions #9

Open
wants to merge 7 commits into
base: master
Choose a base branch
from

Conversation

tbuschto
Copy link
Member

@tbuschto tbuschto commented Feb 19, 2019

This PR corresponds to gerrit change 17855. It is meant for preview, commenting and discussion, the actual commit votes should be given on gerrit.

Since this it too much for a single person to review in one go i would hope that everyone has a look at an another article every now and then until everything has been covered by at least one person.

This is the first round of planned changes to the developer guide, basically revising all content we already have. After this is merged I plan on splitting and adding a few articles, add/check links, snippets and screenshots, etc.

Comment here: https://github.com/eclipsesource/tabris-js-docs/pull/9/files. Click "View file" to see it rendered.

docs/3.0/JSX.md Outdated Show resolved Hide resolved
docs/3.0/JSX.md Outdated Show resolved Hide resolved
docs/3.0/build.md Outdated Show resolved Hide resolved
docs/3.0/cordova.md Outdated Show resolved Hide resolved
docs/3.0/debug.md Outdated Show resolved Hide resolved
docs/3.0/developer-app.md Outdated Show resolved Hide resolved
docs/3.0/developer-app.md Outdated Show resolved Hide resolved
docs/3.0/faq.md Outdated Show resolved Hide resolved
docs/3.0/faq.md Outdated Show resolved Hide resolved
docs/3.0/faq.md Outdated Show resolved Hide resolved
docs/3.0/getting-started.md Outdated Show resolved Hide resolved
docs/3.0/layout.md Outdated Show resolved Hide resolved
docs/3.0/layout.md Outdated Show resolved Hide resolved
docs/3.0/layout.md Outdated Show resolved Hide resolved
docs/3.0/layout.md Outdated Show resolved Hide resolved
docs/3.0/layout.md Outdated Show resolved Hide resolved
docs/3.0/layout.md Outdated Show resolved Hide resolved
docs/3.0/layout.md Outdated Show resolved Hide resolved
docs/3.0/layout.md Outdated Show resolved Hide resolved
docs/3.0/selector.md Outdated Show resolved Hide resolved
docs/3.0/selector.md Outdated Show resolved Hide resolved
docs/3.0/selector.md Outdated Show resolved Hide resolved
docs/3.0/selector.md Outdated Show resolved Hide resolved
docs/3.0/touch.md Outdated Show resolved Hide resolved
docs/3.0/types.md Outdated Show resolved Hide resolved
docs/3.0/types.md Outdated Show resolved Hide resolved
docs/3.0/types.md Outdated Show resolved Hide resolved
docs/3.0/types.md Outdated Show resolved Hide resolved
docs/3.0/faq.md Outdated Show resolved Hide resolved
docs/3.0/JSX.md Show resolved Hide resolved
docs/3.0/JSX.md Outdated Show resolved Hide resolved
docs/3.0/build.md Show resolved Hide resolved
docs/3.0/build.md Show resolved Hide resolved
docs/3.0/build.md Outdated Show resolved Hide resolved
docs/3.0/ui.md Show resolved Hide resolved
docs/3.0/widget-basics.md Outdated Show resolved Hide resolved
docs/3.0/widget-basics.md Outdated Show resolved Hide resolved
docs/3.0/widget-basics.md Outdated Show resolved Hide resolved
docs/3.0/widget-basics.md Outdated Show resolved Hide resolved
Copy link
Member

@jonek jonek left a comment

Choose a reason for hiding this comment

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

I left some comments.

docs/3.0/build.md Outdated Show resolved Hide resolved
docs/3.0/build.md Outdated Show resolved Hide resolved
docs/3.0/build.md Show resolved Hide resolved
docs/3.0/build.md Outdated Show resolved Hide resolved
docs/3.0/build.md Show resolved Hide resolved
| Name | Value |
|-------------------------|-------|
| Theme |- `@style/Theme.Tabris`<br/>- `@style/Theme.Tabris.Light`<br/>- `@style/Theme.Tabris.Light.DarkAppBar` (Default)<br/><br/>In addition to the bundled Tabris themes, a resource reference to a custom Android theme can be specified. Custom themes have to inherit from one of the Tabris base themes.<br/><br/>Example: `<preference name="Theme" value="@style/Theme.MyAppTheme" />` |
| ThemeSplash | - `@style/Theme.Tabris.SplashScreen`<br/>- `@style/Theme.Tabris.Light.SplashScreen` (Default)<br/><br/>The splash screen is shown to the user while the app is starting up. By default this screen has a white background. The `ThemeSplash` preference allows to set one of the bundled themes or to provide a custom theme.<br/><br/>Example: `<preference name="ThemeSplash" value="@style/Theme.Tabris.SplashScreen" />`<br/><br/>Note that the `config.xml` element `<splash .. />` can be used to set an image on the splash screen. For styling guides see the material design guidelines on [launch screens](https://material.google.com/patterns/launch-screens.html). |
Copy link
Member

Choose a reason for hiding this comment

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

Same thought as @cpetrov we should link to visual examples i.e. screenshots.

docs/3.0/build.md Show resolved Hide resolved

On the first start, the Tabris CLI will ask for a build key.
You can find this key on your [profile page](https://tabrisjs.com/settings/account).

Copy link
Member

Choose a reason for hiding this comment

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

Maybe add a screenshot here that shows where to find the "build key".

Copy link
Member Author

Choose a reason for hiding this comment

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

O yeah, i have been asked that many times. But maybe a more prominent placement would be even better than a screenshot?

Remove references to iOS 9 (no longer supported)

### What Cordova versions is Tabris.js based on?

| | Tabris.js 3.x |
Copy link
Member Author

Choose a reason for hiding this comment

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

@mpost What about Tabris.js 2?

@cpetrov cpetrov self-requested a review March 4, 2019 15:18
@tbuschto tbuschto force-pushed the master branch 2 times, most recently from f723f92 to 95401f3 Compare August 30, 2019 15:11
@tbuschto tbuschto force-pushed the master branch 3 times, most recently from f6e3b99 to cf51d9e Compare October 2, 2020 13:45
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.

4 participants