docs: add an onboarding page for developers and coding agents - #197
Draft
Mateus Zitelli (MateusZitelli) wants to merge 1 commit into
Draft
docs: add an onboarding page for developers and coding agents#197Mateus Zitelli (MateusZitelli) wants to merge 1 commit into
Mateus Zitelli (MateusZitelli) wants to merge 1 commit into
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Overview of Problem
We want to offer
qawolf.com/onboard.md, a Markdown page that a developer or a coding agent can fetch to install the CLI, connect it to a workspace, and run flows. The marketing site on Webflow cannot serve a Markdown page from git.Overview of Changes
onboard.mdxat the root of the docs. Mintlify serves it athttps://docs.qawolf.com/onboardand as Markdown athttps://docs.qawolf.com/onboard.md.The content is a seven-step procedure: install, authenticate, find the environment ID, pull flows and install the runtime, run locally, start a platform run, and install the agent skill. Every command comes from the existing CLI reference pages.
To Do
/onboard.mdtohttps://docs.qawolf.com/onboard.md.