Restructure docs and add introduction content #167
Conversation
Moved existing documentation to backup-old-docs/ to archive previous versions. Added new introduction and supported platforms documentation under introduction/, and updated .gitignore to include Vale linter and GitBook development files.
|
We don't want this merging yet, right? |
|
@Fishbowler no, this is the staging new documentation site. |
|
We will work only on this branch, separated from the main documentation site. |
|
@mtgr18977 Mind if I kick the PR into draft, just in case someone gets clicky? |
|
Also, let me know when you want reviews |
Not at all. Just kick it. |
You can start reviewing any time you want. |
|
@Fishbowler |
mtgr18977
requested review from
Fishbowler,
Leland-Takamine and
simon-gilmurray
Fishbowler
left a comment
Fishbowler
left a comment
There was a problem hiding this comment.
A quick pass of the first couple of files
There was a problem hiding this comment.
"Maestro cloud" => "Maestro Cloud" throughout this one.
There was a problem hiding this comment.
I will put this on out linter to avoid new errors.
Reorganized SUMMARY.md to group content under new sections such as Introduction, Maestro Studio, Maestro CLI, Cloud, Flows, Command Reference, Best Practices, Javascript With Maestro, Use Cases, Troubleshooting, and Community. This update streamlines navigation and reflects a more logical documentation structure.
Removed front matter from README.md and reformatted the strategic note in cloud.md to use a hint block for improved clarity and consistency in documentation.
Revised README.md for improved clarity, grammar, and branding consistency. Updated cloud infrastructure references and reworded feature descriptions for readability. Changed SUMMARY.md to rename the main documentation link to 'What is Maestro?'.
Replaced plain note text with styled hint blocks in Maestro MCP, Maestro Studio, repository config, and web browser support documentation for improved readability and consistency.
Changed hint styles in several documentation files for consistency (e.g., 'info' to 'warning' or 'success'). Added clarification on UI interaction patterns in Jetpack Compose support documentation. Improved formatting and accuracy in installation and configuration instructions.
Updated headings for clarity in CLI and cloud documentation, improved link formatting in Maestro MCP introduction, and restructured feature descriptions in Maestro Studio documentation for better readability.
Corrected and reorganized links for Android Native and Web Browsers in the supported platforms section to improve navigation and accuracy.
Reordered 'What is Maestro?' in SUMMARY.md for better navigation. Enhanced formatting in maestro-studio.md by bolding feature headings for clarity. Streamlined section titles in uikit.md to improve readability and consistency.
Co-authored-by: Dan Caseley <[email protected]>
Moved existing documentation to backup-old-docs/ to archive previous versions. Added new introduction and supported platforms documentation under introduction/, and updated .gitignore to include Vale linter and GitBook development files.