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

Add names to all our documentation #1297

Closed
Sloox opened this issue Nov 4, 2020 · 1 comment · Fixed by #1311
Closed

Add names to all our documentation #1297

Sloox opened this issue Nov 4, 2020 · 1 comment · Fixed by #1311
Assignees

Comments

@Sloox
Copy link
Contributor

Sloox commented Nov 4, 2020

The documentation has a mix and match of named or only explanations given for fields that can be used for flank.

This applies to both ios, android and common flank.

EG:

## The path to a Robo Script JSON file.
  ## The path may be in the local filesystem or in Google Cloud Storage using gs:// notation.
  ## You can guide the Robo test to perform specific actions by recording a Robo Script in Android Studio and then specifying this argument.
  ## Learn more at https://firebase.google.com/docs/test-lab/robo-ux-test#scripting.
  # robo-script: path_to_robo_script

Lets add a name for example:

  ### Robo-Script
  ## The path to a Robo Script JSON file.
  ## The path may be in the local filesystem or in Google Cloud Storage using gs:// notation.
  ## You can guide the Robo test to perform specific actions by recording a Robo Script in Android Studio and then specifying this argument.
  ## Learn more at https://firebase.google.com/docs/test-lab/robo-ux-test#scripting.
  # robo-script: path_to_robo_script

This makes it more readable when actually reading documentation. Getting hit with a wall of text that starts with explanation of a un-named option is bad practise.
This will apply to all text found in
index.md, flank.yml. It could be elsewhere in the project too and needs to be investigated and fixed.

WDYT?

@bootstraponline
Copy link
Contributor

this is awesome @Sloox !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants