Quickstart
Overview
Section titled “Overview”This quickstart gets Promptless drafting documentation updates for your team. You create an account, then work through a five-step setup wizard. The wizard connects your chat tool, your docs repository, the code providers whose changes start documentation work, and the tools that hold product context. When you finish, Promptless indexes your docs and starts watching for changes.
Connecting your docs repository is the only step you must complete. You can connect everything else later.
Before you start
Section titled “Before you start”-
A Promptless account. Sign up for a free account at accounts.gopromptless.ai.
-
Admin access to the tools you plan to connect, depending on your organization’s settings:
Integration Access you need Slack Workspace admin permissions to install the Promptless app GitHub Organization admin, or enough repository access to install the GitHub App Jira and Confluence Atlassian admin permissions to authorize the OAuth connection Linear Workspace admin permissions to connect the integration
If you don’t have the access an integration needs, invite a teammate who does. In the wizard, select Invite team members under Need an admin?. The invited person receives an email that brings them to the same setup page, and they continue from the current step.
Choose what to set up
Section titled “Choose what to set up”When you first sign in, choose what you want to set up:
- Docs: Keep your documentation up to date. You continue to the guided setup wizard.
- Agent Instructions: Improve the instructions your AI agents follow. You book a guided setup call with the Promptless team, who help connect your instructions and agree on pricing with you.
- Both: Start with Docs setup in the wizard. The Promptless team follows up about Agent Instructions.
You need to be an organization admin to make this choice. To change it before you finish setup, select Change product choice on the Agent Instructions setup page.
Complete the setup wizard
Section titled “Complete the setup wizard”If you chose Docs or Both, the setup wizard opens next. Your progress saves automatically, so you can leave and pick up where you left off.
-
Connect chat. Connect Slack or Microsoft Teams. Promptless uses chat for notifications and for documentation requests that start in a conversation. If you use neither, book a setup call from this step.
If your Slack workspace requires admin approval, the wizard shows a pending Slack card while you wait. After an admin approves, select Continue in Slack on the card to finish connecting. See Connect Slack.
-
Connect docs. Install the Promptless GitHub App or connect GitLab, then pick the repositories where your documentation lives. Each repository you pick becomes a doc collection, and you can add more doc collections at any time. You must complete this step to finish setup.
-
Connect triggers. Optional. Connect the code providers whose changes should start documentation updates: GitHub or GitLab. If you skip this step, connect the provider before you add or change its triggers. See Connect a provider before you add its triggers.
-
Connect context. Optional. Connect Atlassian (Jira and Confluence), Linear, or Notion to give Promptless more context for its suggestions.
-
Review set-up. Check the connection summary, review your recommended plan and check out, then select Finish setup. See Choose a plan and check out. Optional: book a setup review call so the Promptless team can help tune your configuration.
Choose a plan and check out
Section titled “Choose a plan and check out”On the Review set-up step, Promptless measures the documentation you connected and recommends a Docs plan. It counts roughly every 400 words as one page, so the page count can differ from the number of files in your repository. The step shows the page count and the recommended plan.
- Startup: Select Continue to secure checkout and add a card in Stripe. The plan includes 14 days free, then $500/month. Cancel before the free period ends to avoid a charge.
- Growth or Enterprise: Select Book a plan and setup call. The Promptless team confirms your quote and helps you finish setup on the call.
Connected integrations can also determine the plan. Some integrations require Growth or above, even for a small documentation set. See Pricing for what each plan includes.
Finish setup becomes available after Promptless confirms your checkout, which usually takes a few seconds. If you selected Both, this checkout covers Docs only. The Promptless team arranges Agent Instructions pricing with you separately.
Review what Promptless set up
Section titled “Review what Promptless set up”When you finish setup, Promptless indexes your docs repository. Indexing takes 5–30 minutes, depending on the size of your docs.
Promptless also writes your configuration from the integrations you connected:
| Integration you connected | What Promptless adds |
|---|---|
| GitHub or GitLab | A pull request or merge request trigger that covers all your repositories |
| Jira, Confluence, Linear, Notion, Google Drive, or Slite | A context source that covers all the data the integration reaches |
From then on, Promptless opens a pull request in your docs repository for each suggestion. On GitLab, it opens a merge request. To review suggestions as drafts first, turn off Open a pull request automatically in the publishing policies.
To change these defaults, for example to limit a trigger to specific repositories, edit them on the Configuration page. For the exact settings, see Initial configuration from onboarding.
Review your first suggestion
Section titled “Review your first suggestion”When you finish setup, Promptless checks the pull requests and merge requests that your triggers match and that merged in the last 14 days. If it finds a change your docs don’t cover, it drafts one suggestion.
This suggestion stays on the Suggestions page until you select Create PR. Promptless doesn’t open a PR or send a notification for it, whatever your publishing policy says.
See also
Section titled “See also”- Triggers, for every event that can start documentation work and how to follow what a trigger did
- Configuration reference, for the complete
promptless.yamlschema and how to narrow triggers to specific repositories - Slack integration, for the permissions the Slack app requests and how to update them
- Run a pilot, to plan a 14-day evaluation with your own docs
Need help with integrations? Contact us at help@gopromptless.ai.