search

NativeScript / docs

The NativeScript Docs!
https://docs.nativescript.org/
12 stars 23 forks source link

fix: update `/configuration/nativescript` page #123

Closed achou11 closed 9 months ago

achou11 commented 9 months ago

Mostly includes fix for spelling and grammar but also includes some small aesthetic improvements to the markup (i.e. code block wrapping for some known commands/fields that are referenced)

achou11 commented 9 months ago

Also, wanted to get some thoughts on the following before implementing changes since it may just be my personal preference:

  1. I find it a little confusing that a lot of the options give an example that's setting to a value that isn't the default. For example:

    image

    Not sure why, but if there's a default set for the option, I would expect the example to show that being the case.

  2. Would be good to more explicitly note what fields are required vs optional. Can be achieved either with some annotation like (required) or (optional) and/or adding to the TS type for the relevant example e.g. android.handleTimezoneChanges ?: boolean = ...

  3. There's also some inconsistency throughout the page where some of the options show a value being set and others where it doesn't - regardless of if the option is optional or not. Would be nice to make it more uniform

NathanWalker commented 9 months ago

All great thoughts and agreed on all @achou11

  1. 100% - feel free to change these as you suggested.
  2. The heading line may be more clear to use (optional) after it to be clear. But I could also see ? optional chaining being clear as well. Whichever works and feels right to you I think would work - great point.
  3. Would be much nicer for them all to be the same yes.

We'll merge this one as nice corrections already and feel free to post followup on above, thank you!