Skip to content

For the complete documentation index, see llms.txt.

GitLab projects

In Promptless, a doc collection is a place where your documentation lives. When your docs are in GitLab, on gitlab.com or self-hosted, the doc collection is a GitLab project. You can limit Promptless to specific paths in that project.

To set this up, connect the GitLab group that holds the project, then select the project on the Configuration page.

You can also ask Promptless in Slack or Microsoft Teams to add the doc collection for you. For example, “@Promptless add my acme/docs GitLab project as a doc collection.” See Ask Promptless to update your configuration.

Skip this section if the group that holds your docs project already has a card on the Integrations page.

You need the Owner role on the GitLab group to create its access token, and an admin role in your Promptless organization to connect it. If you aren’t a group Owner, ask one to create the token.

Create a token that only Promptless uses. Promptless counts every merge request the token opens as its own and skips it as a trigger event.

  1. In GitLab, go to your group’s Settings > Access Tokens and select Add new token.

  2. Name the token, for example “Promptless”, and set an expiration date. The maximum is one year.

  3. Select the api scope and the Maintainer role. Promptless installs merge-request webhooks only on projects where the token has the Maintainer role.

  4. Select Create group access token, and copy the token. GitLab shows it only once. The token starts with glpat-. For more details, see GitLab’s group access token documentation.

  5. In the Promptless dashboard, open the Integrations page.

  6. Start the connection. For a gitlab.com group, select Connect GitLab on the GitLab tile. For a self-hosted instance, select Connect Self-hosted GitLab on the Self-hosted GitLab tile, and enter your Instance hostname. Enter only the host, with no https:// and no path.

  7. In the Group path field, enter the group’s full path, for example acme/platform.

  8. Paste the token into the Access token field, and select Connect.

    Connect GitLab modal with Group path and Access token fields and a Connect button

The token must be a group access token with the api scope. Promptless checks the scope when you connect and rejects a token without it. For why, see Token scope considerations.

The group gets its own card on the Integrations page. To connect another group, select Connect GitLab or Connect Self-hosted GitLab again and repeat these steps with that group’s token.

  1. On the Doc collections tab of the Configuration page, select Add doc collection.

  2. Under Which repository should Promptless document?, select your GitLab project. To list only your GitLab projects, search for gitlab.

  3. Set the docs framework, published URL, and path scope. These settings work the same as for a GitHub doc collection.

  4. Select Add collection.

If the picker doesn’t list your project, connect the group that holds it.

Set platform: gitlab and use the project’s full path as the key. For a self-hosted project, also set host:

doc_collections:
acme/docs: # gitlab.com project
platform: gitlab
docs_framework: docusaurus
acme/platform/developer-docs: # self-hosted, nested namespace
platform: gitlab
host: gitlab.acme.com
docs_framework: mkdocs

See the configuration reference for every field a doc collection accepts.

Onboarding turns on automatic PR creation (publishing.auto_create_pr), so Promptless opens a merge request for each suggestion. Keep it on. Reviewers then get suggestions in GitLab with their other merge requests.

With it off, suggestions stay in the Promptless dashboard until someone opens a merge request for each one by hand.

Change the setting in your publishing policies.

If a pipeline fails on a Promptless merge request, add a comment to the merge request. Mention @promptless in the comment and paste the output of the failed job. Promptless reads the output and pushes a fix to the merge request branch.