Skip to content

docs: add mintlify-docs folder with community docs content#95

Merged
droid-ash merged 2 commits into
mainfrom
add-mintlify-docs-folder
Apr 19, 2026
Merged

docs: add mintlify-docs folder with community docs content#95
droid-ash merged 2 commits into
mainfrom
add-mintlify-docs-folder

Conversation

@droid-ash
Copy link
Copy Markdown
Contributor

@droid-ash droid-ash commented Apr 19, 2026

Summary

  • Adds mintlify-docs/ folder containing the Mintlify community docs content (index, quickstart, installation, configuration, running, tests, troubleshooting, FAQ, etc.)
  • Seeds docs site source in-repo so it can be edited alongside code changes

Test plan

  • Verify mintlify-docs/docs.json structure renders as expected in Mintlify preview
  • Confirm no sensitive files committed (LICENSE, READMEs, .mintignore only)

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Launched comprehensive FinalRun documentation site covering installation, quickstart, and YAML test format.
    • Added configuration guides for workspace setup, environments, and AI provider integration.
    • Added CLI reference, AI agent skills guide, and test reports documentation.
    • Added troubleshooting and FAQ resources for common setup issues.

droid-ash and others added 2 commits April 19, 2026 14:37
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 19, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 283e6edf-a14a-40f1-a918-49e461e819a0

📥 Commits

Reviewing files that changed from the base of the PR and between 1169820 and 32161a6.

📒 Files selected for processing (22)
  • mintlify-docs/.atlas-analysis.json
  • mintlify-docs/.mintignore
  • mintlify-docs/AGENTS.md
  • mintlify-docs/CONTRIBUTING.md
  • mintlify-docs/LICENSE
  • mintlify-docs/README.md
  • mintlify-docs/configuration/ai-providers.mdx
  • mintlify-docs/configuration/environments.mdx
  • mintlify-docs/configuration/workspace.mdx
  • mintlify-docs/docs.json
  • mintlify-docs/faq.mdx
  • mintlify-docs/index.mdx
  • mintlify-docs/installation.mdx
  • mintlify-docs/introduction.mdx
  • mintlify-docs/quickstart.mdx
  • mintlify-docs/running/ai-agent-skills.mdx
  • mintlify-docs/running/cli-reference.mdx
  • mintlify-docs/running/reports.mdx
  • mintlify-docs/tests/placeholders.mdx
  • mintlify-docs/tests/suites.mdx
  • mintlify-docs/tests/yaml-format.mdx
  • mintlify-docs/troubleshooting.mdx

📝 Walkthrough

Walkthrough

This PR adds comprehensive documentation for FinalRun, a CLI tool for AI-powered mobile testing. It introduces 20+ new files including project metadata, setup guides, configuration documentation, CLI reference, test-writing guides, and troubleshooting resources across a Mintlify documentation site.

Changes

Cohort / File(s) Summary
Project Configuration & Setup
mintlify-docs/.atlas-analysis.json, mintlify-docs/.mintignore, mintlify-docs/docs.json, mintlify-docs/README.md, mintlify-docs/LICENSE, mintlify-docs/CONTRIBUTING.md, mintlify-docs/AGENTS.md
Adds Mintlify documentation site configuration, metadata about public API surface (CLI commands, skills, config paths), exclusion rules for draft content, license, and contribution/agent setup guides.
Getting Started & Overview
mintlify-docs/index.mdx, mintlify-docs/introduction.mdx, mintlify-docs/installation.mdx, mintlify-docs/quickstart.mdx
Introduces FinalRun's purpose and workflow, installation instructions for Node.js CLI with platform prerequisites (Android/iOS), and step-by-step quick-start guide for first test execution.
Configuration Documentation
mintlify-docs/configuration/workspace.mdx, mintlify-docs/configuration/environments.mdx, mintlify-docs/configuration/ai-providers.mdx
Describes workspace layout, .finalrun/config.yaml fields, environment/secret binding via .finalrun/env/ YAML files, and bring-your-own-key AI provider configuration (Google, OpenAI, Anthropic).
Test Writing & Format
mintlify-docs/tests/yaml-format.mdx, mintlify-docs/tests/suites.mdx, mintlify-docs/tests/placeholders.mdx
Documents YAML test specification schema (setup/steps/expected_state phases), suite manifest bundling for batch execution, and placeholder resolution for secrets and variables.
Running Tests & Reports
mintlify-docs/running/cli-reference.mdx, mintlify-docs/running/ai-agent-skills.mdx, mintlify-docs/running/reports.mdx
Provides comprehensive CLI command reference, AI coding agent skills installation/usage workflow, and test artifact storage/viewing via local report UI.
Help & Support
mintlify-docs/faq.mdx, mintlify-docs/troubleshooting.mdx
Answers common questions about account requirements, pricing, CI/CD integration, and device support; troubleshoots setup errors and dependencies.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~18 minutes

Possibly related PRs

Suggested labels

documentation

Suggested reviewers

  • arnoldlaishram

Poem

🐰 Hop through docs with glee,
YAML schemas, configs to see,
CLI commands all laid bare,
From setup to tests, with utmost care,
FinalRun shines, crystal clear!

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch add-mintlify-docs-folder

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@droid-ash droid-ash merged commit 5441886 into main Apr 19, 2026
1 check was pending
@droid-ash droid-ash self-assigned this Apr 28, 2026
@droid-ash droid-ash added the documentation Improvements or additions to documentation label Apr 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant