Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
83 commits
Select commit Hold shift + click to select a range
2c35520
Restructure docs and add introduction content
mtgr18977 Dec 19, 2025
e8e3c74
Restructure and simplify documentation summary
mtgr18977 Dec 22, 2025
eebdc65
Update .gitbook.yaml
mtgr18977 Dec 22, 2025
8dbff9d
Update documentation formatting and strategic note
mtgr18977 Dec 22, 2025
0c75dfd
Update how-to-install.md
mtgr18977 Dec 22, 2025
f9fb5f5
Update how-to-install.md
mtgr18977 Dec 22, 2025
8524137
Update how-to-install.md
mtgr18977 Dec 22, 2025
8f53051
Update SUMMARY.md
mtgr18977 Dec 22, 2025
66ab9a6
Update README and SUMMARY for clarity and branding
mtgr18977 Dec 22, 2025
608c364
Update README.md
mtgr18977 Dec 22, 2025
2340ac7
Convert notes to hint blocks in introduction docs
mtgr18977 Dec 22, 2025
1394cac
Update hint styles and clarify UI interaction in docs
mtgr18977 Dec 22, 2025
8c4aff5
Refine headings and formatting in solution docs
mtgr18977 Dec 22, 2025
7b157be
Update supported platforms links in SUMMARY.md
mtgr18977 Dec 22, 2025
5d44368
Improve documentation formatting and structure
mtgr18977 Dec 22, 2025
908e7ff
Update SUMMARY.md
mtgr18977 Dec 22, 2025
945ae27
Update introduction/our-solutions/cli.md
mtgr18977 Dec 22, 2025
09a96a4
Update introduction/our-solutions/cli.md
mtgr18977 Dec 22, 2025
19672a4
Add Vale linter configuration and Google style rules
mtgr18977 Dec 22, 2025
08e6c87
Merge branch 'staging' of https://github.com/mobile-dev-inc/maestro-d…
mtgr18977 Dec 22, 2025
744891b
`docs`: add a new explanation in the flutter.md file.
mtgr18977 Dec 22, 2025
052a115
`docs`: remove OCR mistakes.
mtgr18977 Dec 22, 2025
0763d88
`docs`: Add the "How To Run Your First Test" article. (#168)
mtgr18977 Dec 23, 2025
46e9d09
`docs`: Add the environment variables on Maestro Studio guide. (#169)
mtgr18977 Dec 23, 2025
dbfff59
`docs`: Add the "How to install Maestro CLI" doc. (#170)
mtgr18977 Dec 23, 2025
d2efc7e
Update SUMMARY.md
mtgr18977 Dec 23, 2025
f2869d5
`docs`: update the Start here section name and add the new images.
mtgr18977 Dec 23, 2025
cbf31d9
`docs`: change SUMMARY and the name of the Env Var on Maestro Studio.
mtgr18977 Dec 23, 2025
4020c26
Update SUMMARY.md
mtgr18977 Dec 23, 2025
76ab434
Update no-device.png
mtgr18977 Dec 23, 2025
39da9b3
`docs`: added the Maestro CLI docs.
mtgr18977 Dec 26, 2025
f948416
Update introduction/our-solutions/cli.md
mtgr18977 Dec 26, 2025
ee2e096
Update SUMMARY.md
mtgr18977 Dec 26, 2025
7899bd4
Merge branch 'staging' of https://github.com/mobile-dev-inc/maestro-d…
mtgr18977 Dec 26, 2025
174ff8e
Update wsl-2.md
mtgr18977 Dec 26, 2025
785e7fb
`docs`: corect the hints on the docs from WSL2
mtgr18977 Dec 26, 2025
4841dda
`docs`: added the command reference for CLI
mtgr18977 Dec 26, 2025
e9d5c40
Update WordList.yml
mtgr18977 Dec 26, 2025
4af58a6
Update cli-commands.md
mtgr18977 Dec 26, 2025
0edbbe9
Update cli-commands.md
mtgr18977 Dec 26, 2025
8a6dd48
Update SUMMARY.md
mtgr18977 Dec 26, 2025
b8fbf97
Update SUMMARY.md
mtgr18977 Dec 26, 2025
6bc27b2
`docs`: added the Javascript and Maestro Cloud.
mtgr18977 Dec 29, 2025
d2507cb
Create js-outputs.md
mtgr18977 Dec 29, 2025
701fbfe
GITBOOK-9: No subject
htessaro Dec 31, 2025
4e82480
GITBOOK-10: No subject
htessaro Jan 1, 2026
6974100
GITBOOK-11: No subject
htessaro Jan 2, 2026
dec3654
GITBOOK-12: No subject
htessaro Jan 5, 2026
754013b
GITBOOK-13: No subject
htessaro Jan 5, 2026
ce53b81
GITBOOK-14: No subject
htessaro Jan 5, 2026
283df04
GITBOOK-15: No subject
htessaro Jan 5, 2026
00e4938
GITBOOK-16: No subject
htessaro Jan 5, 2026
8696e2a
GITBOOK-17: No subject
htessaro Jan 6, 2026
84d1bd9
GITBOOK-18: No subject
htessaro Jan 6, 2026
a96f117
GITBOOK-19: No subject
htessaro Jan 7, 2026
d89daec
GITBOOK-20: No subject
htessaro Jan 7, 2026
16cc000
GITBOOK-21: No subject
htessaro Jan 7, 2026
54353fd
GITBOOK-22: No subject
htessaro Jan 7, 2026
5bba8da
GITBOOK-23: No subject
htessaro Jan 7, 2026
ae72165
GITBOOK-24: No subject
htessaro Jan 7, 2026
de64fb5
GITBOOK-25: No subject
htessaro Jan 7, 2026
d3d0a1e
GITBOOK-26: No subject
htessaro Jan 7, 2026
d4c8370
GITBOOK-27: No subject
htessaro Jan 7, 2026
d35fe71
GITBOOK-28: No subject
htessaro Jan 8, 2026
ee8835f
GITBOOK-29: No subject
htessaro Jan 8, 2026
b80fe80
GITBOOK-30: No subject
htessaro Jan 8, 2026
03acd01
GITBOOK-31: No subject
htessaro Jan 12, 2026
55afe1e
GITBOOK-32: No subject
htessaro Jan 12, 2026
7988bbb
GITBOOK-33: No subject
htessaro Jan 12, 2026
2abf988
GITBOOK-34: No subject
htessaro Jan 12, 2026
e615db0
GITBOOK-35: No subject
htessaro Jan 13, 2026
ebb314d
GITBOOK-36: No subject
htessaro Jan 13, 2026
1b07e16
GITBOOK-37: No subject
htessaro Jan 13, 2026
6c2c31c
GITBOOK-38: No subject
htessaro Jan 13, 2026
f737838
GITBOOK-39: No subject
htessaro Jan 13, 2026
93a72d8
GITBOOK-40: No subject
htessaro Jan 13, 2026
df4cac8
GITBOOK-41: No subject
htessaro Jan 13, 2026
97de350
GITBOOK-42: No subject
htessaro Jan 13, 2026
010fbe1
GITBOOK-43: No subject
htessaro Jan 13, 2026
3f62ac4
GITBOOK-44: No subject
htessaro Jan 13, 2026
7005e83
GITBOOK-45: No subject
htessaro Jan 13, 2026
248a2fc
GITBOOK-46: No subject
htessaro Jan 13, 2026
6e24a4e
GITBOOK-47: No subject
htessaro Jan 15, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions .gitbook.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,3 @@ root: ./
structure:
readme: README.md
summary: SUMMARY.md

redirects:
api-reference/labels: api-reference/commands/README.md
Binary file added .gitbook/assets/add-env.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/add-var.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/environment.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/first-test-quickstart-android.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .gitbook/assets/image (1) (1).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .gitbook/assets/image (1).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .gitbook/assets/image (2).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .gitbook/assets/image (3).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .gitbook/assets/image (4).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .gitbook/assets/image (5).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .gitbook/assets/image (6).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .gitbook/assets/image.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/no-device.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/quickstart-1 (1).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/quickstart-1 (2).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/quickstart-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/quickstart-create-a-new-test.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/quickstart-create-test.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/quickstart-devices-available.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/quickstart-explore-options.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/workspace-test.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
.idea/

# GitBook local development
gitbook-manifest.yaml
21 changes: 21 additions & 0 deletions .vale.ini
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Vale configuration for Maestro documentation
StylesPath = .vale/styles

MinAlertLevel = suggestion

# Packages to install
Packages = Google

# Core settings
[*.{md,mdx}]
# Use these styles
BasedOnStyles = Vale, Google

# Vocabulary settings - ignore project-specific terms
vocab = Maestro

# Vale customizations
Vale.Spelling = NO

# Ignore code blocks and inline code
TokenIgnores = (\$\{[^}]+\}), (`[^`]+`), (```[\s\S]*?```)
9 changes: 9 additions & 0 deletions .vale/styles/Google/AMPM.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
extends: existence
message: "Use 'AM' or 'PM' (preceded by a space)."
link: "https://developers.google.com/style/word-list"
level: error
nonword: true
tokens:
- '\d{1,2}[AP]M\b'
- '\d{1,2} ?[ap]m\b'
- '\d{1,2} ?[aApP]\.[mM]\.'
64 changes: 64 additions & 0 deletions .vale/styles/Google/Acronyms.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
extends: conditional
message: "Spell out '%s', if it's unfamiliar to the audience."
link: 'https://developers.google.com/style/abbreviations'
level: suggestion
ignorecase: false
# Ensures that the existence of 'first' implies the existence of 'second'.
first: '\b([A-Z]{3,5})\b'
second: '(?:\b[A-Z][a-z]+ )+\(([A-Z]{3,5})\)'
# ... with the exception of these:
exceptions:
- API
- ASP
- CLI
- CPU
- CSS
- CSV
- DEBUG
- DOM
- DPI
- FAQ
- GCC
- GDB
- GET
- GPU
- GTK
- GUI
- HTML
- HTTP
- HTTPS
- IDE
- JAR
- JSON
- JSX
- LESS
- LLDB
- NET
- NOTE
- NVDA
- OSS
- PATH
- PDF
- PHP
- POST
- RAM
- REPL
- RSA
- SCM
- SCSS
- SDK
- SQL
- SSH
- SSL
- SVG
- TBD
- TCP
- TODO
- URI
- URL
- USB
- UTF
- XML
- XSS
- YAML
- ZIP
8 changes: 8 additions & 0 deletions .vale/styles/Google/Colons.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
extends: existence
message: "'%s' should be in lowercase."
link: 'https://developers.google.com/style/colons'
nonword: true
level: warning
scope: sentence
tokens:
- '(?<!:[^ ]+?):\s[A-Z]'
30 changes: 30 additions & 0 deletions .vale/styles/Google/Contractions.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
extends: substitution
message: "Use '%s' instead of '%s'."
link: 'https://developers.google.com/style/contractions'
level: suggestion
ignorecase: true
action:
name: replace
swap:
are not: aren't
cannot: can't
could not: couldn't
did not: didn't
do not: don't
does not: doesn't
has not: hasn't
have not: haven't
how is: how's
is not: isn't
it is: it's
should not: shouldn't
that is: that's
they are: they're
was not: wasn't
we are: we're
we have: we've
were not: weren't
what is: what's
when is: when's
where is: where's
will not: won't
9 changes: 9 additions & 0 deletions .vale/styles/Google/DateFormat.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
extends: existence
message: "Use 'July 31, 2016' format, not '%s'."
link: 'https://developers.google.com/style/dates-times'
ignorecase: true
level: error
nonword: true
tokens:
- '\d{1,2}(?:\.|/)\d{1,2}(?:\.|/)\d{4}'
- '\d{1,2} (?:Jan(?:uary)?|Feb(?:ruary)?|Mar(?:ch)?|Apr(?:il)|May|Jun(?:e)|Jul(?:y)|Aug(?:ust)|Sep(?:tember)?|Oct(?:ober)|Nov(?:ember)?|Dec(?:ember)?) \d{4}'
9 changes: 9 additions & 0 deletions .vale/styles/Google/Ellipses.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
extends: existence
message: "In general, don't use an ellipsis."
link: 'https://developers.google.com/style/ellipses'
nonword: true
level: warning
action:
name: remove
tokens:
- '\.\.\.'
13 changes: 13 additions & 0 deletions .vale/styles/Google/EmDash.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
extends: existence
message: "Don't put a space before or after a dash."
link: "https://developers.google.com/style/dashes"
nonword: true
level: error
action:
name: edit
params:
- trim
- " "
tokens:
- '\s[—–]\s'

12 changes: 12 additions & 0 deletions .vale/styles/Google/Exclamation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
extends: existence
message: "Don't use exclamation points in text."
link: "https://developers.google.com/style/exclamation-points"
nonword: true
level: error
action:
name: edit
params:
- trim_right
- "!"
tokens:
- '\w+!(?:\s|$)'
13 changes: 13 additions & 0 deletions .vale/styles/Google/FirstPerson.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
extends: existence
message: "Avoid first-person pronouns such as '%s'."
link: 'https://developers.google.com/style/pronouns#personal-pronouns'
ignorecase: true
level: warning
nonword: true
tokens:
- (?:^|\s)I\s
- (?:^|\s)I,\s
- \bI'm\b
- \bme\b
- \bmy\b
- \bmine\b
9 changes: 9 additions & 0 deletions .vale/styles/Google/Gender.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
extends: existence
message: "Don't use '%s' as a gender-neutral pronoun."
link: 'https://developers.google.com/style/pronouns#gender-neutral-pronouns'
level: error
ignorecase: true
tokens:
- he/she
- s/he
- \(s\)he
43 changes: 43 additions & 0 deletions .vale/styles/Google/GenderBias.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
extends: substitution
message: "Consider using '%s' instead of '%s'."
ignorecase: true
link: "https://developers.google.com/style/inclusive-documentation"
level: error
action:
name: replace
swap:
(?:alumna|alumnus): graduate
(?:alumnae|alumni): graduates
air(?:m[ae]n|wom[ae]n): pilot(s)
anchor(?:m[ae]n|wom[ae]n): anchor(s)
authoress: author
camera(?:m[ae]n|wom[ae]n): camera operator(s)
door(?:m[ae]|wom[ae]n): concierge(s)
draft(?:m[ae]n|wom[ae]n): drafter(s)
fire(?:m[ae]n|wom[ae]n): firefighter(s)
fisher(?:m[ae]n|wom[ae]n): fisher(s)
fresh(?:m[ae]n|wom[ae]n): first-year student(s)
garbage(?:m[ae]n|wom[ae]n): waste collector(s)
lady lawyer: lawyer
ladylike: courteous
mail(?:m[ae]n|wom[ae]n): mail carriers
man and wife: husband and wife
man enough: strong enough
mankind: human kind|humanity
manmade: manufactured
manpower: personnel
middle(?:m[ae]n|wom[ae]n): intermediary
news(?:m[ae]n|wom[ae]n): journalist(s)
ombuds(?:man|woman): ombuds
oneupmanship: upstaging
poetess: poet
police(?:m[ae]n|wom[ae]n): police officer(s)
repair(?:m[ae]n|wom[ae]n): technician(s)
sales(?:m[ae]n|wom[ae]n): salesperson or sales people
service(?:m[ae]n|wom[ae]n): soldier(s)
steward(?:ess)?: flight attendant
tribes(?:m[ae]n|wom[ae]n): tribe member(s)
waitress: waiter
woman doctor: doctor
woman scientist[s]?: scientist(s)
work(?:m[ae]n|wom[ae]n): worker(s)
13 changes: 13 additions & 0 deletions .vale/styles/Google/HeadingPunctuation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
extends: existence
message: "Don't put a period at the end of a heading."
link: "https://developers.google.com/style/capitalization#capitalization-in-titles-and-headings"
nonword: true
level: warning
scope: heading
action:
name: edit
params:
- trim_right
- "."
tokens:
- '[a-z0-9][.]\s*$'
29 changes: 29 additions & 0 deletions .vale/styles/Google/Headings.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
extends: capitalization
message: "'%s' should use sentence-style capitalization."
link: "https://developers.google.com/style/capitalization#capitalization-in-titles-and-headings"
level: warning
scope: heading
match: $sentence
indicators:
- ":"
exceptions:
- Azure
- CLI
- Cosmos
- Docker
- Emmet
- gRPC
- I
- Kubernetes
- Linux
- macOS
- Marketplace
- MongoDB
- REPL
- Studio
- TypeScript
- URLs
- Visual
- VS
- Windows
- JSON
11 changes: 11 additions & 0 deletions .vale/styles/Google/Latin.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
extends: substitution
message: "Use '%s' instead of '%s'."
link: 'https://developers.google.com/style/abbreviations'
ignorecase: true
level: error
nonword: true
action:
name: replace
swap:
'\b(?:eg|e\.g\.)(?=[\s,;])': for example
'\b(?:ie|i\.e\.)(?=[\s,;])': that is
14 changes: 14 additions & 0 deletions .vale/styles/Google/LyHyphens.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
extends: existence
message: "'%s' doesn't need a hyphen."
link: "https://developers.google.com/style/hyphens"
level: error
ignorecase: false
nonword: true
action:
name: edit
params:
- regex
- "-"
- " "
tokens:
- '\b[^\s-]+ly-\w+\b'
12 changes: 12 additions & 0 deletions .vale/styles/Google/OptionalPlurals.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
extends: existence
message: "Don't use plurals in parentheses such as in '%s'."
link: "https://developers.google.com/style/plurals-parentheses"
level: error
nonword: true
action:
name: edit
params:
- trim_right
- "(s)"
tokens:
- '\b\w+\(s\)'
7 changes: 7 additions & 0 deletions .vale/styles/Google/Ordinal.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
extends: existence
message: "Spell out all ordinal numbers ('%s') in text."
link: 'https://developers.google.com/style/numbers'
level: error
nonword: true
tokens:
- \d+(?:st|nd|rd|th)
7 changes: 7 additions & 0 deletions .vale/styles/Google/OxfordComma.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
extends: existence
message: "Use the Oxford comma in '%s'."
link: 'https://developers.google.com/style/commas'
scope: sentence
level: warning
tokens:
- '(?:[^,]+,){1,}\s\w+\s(?:and|or)'
7 changes: 7 additions & 0 deletions .vale/styles/Google/Parens.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
extends: existence
message: "Use parentheses judiciously."
link: 'https://developers.google.com/style/parentheses'
nonword: true
level: suggestion
tokens:
- '\(.+\)'
Loading