Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions fern/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,9 @@ navigation:
path: ./docs/getting-started.mdx
- page: Core Concepts
path: ./docs/core-concepts.mdx
- page: Promptless for Open-Source
slug: promptless-oss
path: ./docs/open-source.mdx
- page: Getting Help
path: ./docs/getting-help.mdx
- page: Pilot Overview
Expand Down
1 change: 1 addition & 0 deletions fern/docs/customer-stories/vellum.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: How Vellum uses Promptless to draft over 50% of their doc updates
subtitle: Published July 2025
description: By democratizing documentation contributions, every team member now drives content—making docs a true team sport powered by Promptless.
---

Expand Down
1 change: 1 addition & 0 deletions fern/docs/life-at-promptless/paper-club.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Running a Lightweight Research Paper Club
subtitle: Published October 2025
description: How we run a weekly paper club at Promptless that's surprisingly useful, surprisingly easy, and has led to tangible product improvements.
---

Expand Down
70 changes: 70 additions & 0 deletions fern/docs/open-source.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
---
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Citation: Created fresh based on Matt Link's request for an accurate OSS quickstart guide. Key details: "Connect GitHub (OSS)" flow, promptless-for-oss service account, and Promptless-managed fork approach.
View source

title: Promptless ❤️ Open-Source
subtitle: Recommendations and tools for open-source projects using Promptless
---

Promptless helps open source projects keep documentation in sync with fast-moving codebases. Use it to automatically update developer docs, generate changelogs for new releases, or handle translations.

<Success title="Open-Source Program" icon="fa-solid fa-heart">
Promptless is free for CNCF, Linux Foundation, and other eligible non-commercial open-source projects. Contact us at help@gopromptless.ai to get started.
</Success>

Open source workflows sometimes differ from commercial software. We've built features and setup guides tailored specifically for open source maintainers.

## Quick Start

The basic setup for your open source project involves three steps:

<Steps>
<Step title="Install the GitHub App">
Connect GitHub from the [Integrations page](https://app.gopromptless.ai/integrations). You'll choose which repositories Promptless can access.

**Which GitHub app should you install?**
- **Standard GitHub app**: If you can install apps with write permissions, Promptless creates branches and PRs directly on your repo.
- **GitHub OSS app (read-only)**: If you can only install read-only apps, Promptless creates PRs from a fork. See the [GitHub integration docs](/docs/integrations/github-integration) for details.
</Step>

<Step title="Set Up Doc Collections">
[Doc Collections](/docs/doc-collections) tell Promptless where your documentation lives.

You can create multiple doc collections if needed—for example, if your changelog is in a different location from your main docs. You can also specify a particular directory if your docs live in a monorepo alongside your code.

See [GitHub Repos (Docs as Code)](/docs/doc-collections/git-hub-repos-docs-as-code) for setup instructions.
</Step>

<Step title="Create a Project">
Create a project from the [Projects page](https://app.gopromptless.ai/projects) to connect your triggers and doc collections.

When creating projects, configure which repos Promptless listens to for PRs and which doc collections to update.

<Tip>
Enable **Replay recent PRs** to run Promptless on your last 30 days of PRs. This gives you an initial batch of suggestions to calibrate with before going live.
</Tip>

Many open source projects prefer to centralize operations in GitHub so anyone can benefit from Promptless without needing an account. If this applies to you, enable **Auto-create PR** so suggestions automatically become pull requests. We recommend turning this on after your initial calibration is complete, so that you're able to refine Promptless's configuration before rolling it out to all contributors.
</Step>
</Steps>

## Recommended Trigger Configuration

Most projects trigger Promptless on opened PRs. For popular open source projects—where many contributor PRs get closed without merging—consider using [GitHub Commit triggers](/docs/triggers/git-hub-commits) instead. This way, Promptless only runs when PRs are actually merged to your default branch. We recommend changing this setting after your initial calibration.

## Additional Use Cases

<AccordionGroup>
<Accordion title="Translation workflows">
For translation workflows, you might want the trigger to be the English directory of your docs. Promptless will then draft updates that translate content to the rest of your documentation.
</Accordion>

<Accordion title="GitHub Issues integration">
If GitHub Issues are part of your workflow, create a GitHub Issues trigger so contributors can tag Promptless in issues to generate doc updates.
</Accordion>

<Accordion title="Updating Contributor PRs (coming soon)">
For some monorepo use cases, you might want Promptless to add a docs commit to your contributors' existing PRs rather than create separate docs PRs. If you're interested in this feature, contact us at help@gopromptless.ai.

Note: this is not compatible with the read-only version of the Promptless Github app.
</Accordion>
</AccordionGroup>


1 change: 1 addition & 0 deletions fern/docs/product-updates/launch-week-dec-2025.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Launch Week: December 2025"
subtitle: Published December 2025
description: Five major features we launched this December, from custom voice matching to automated screenshot updates.
---

Expand Down
1 change: 1 addition & 0 deletions fern/docs/technical/i-must-scream.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "\"I Have No Mouth, and I Must Scream\""
subtitle: Published January 2026
description: What happens when you give an AI agent a Slack channel to complain in.
---

Expand Down