docs: Add Promptless for Open Source quickstart guide #230
There are no files selected for viewing
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| --- | ||
| title: Promptless for Open Source | ||
| --- | ||
|
|
||
| Promptless automatically drafts documentation updates for open source projects when code changes—no write access to your repository required. | ||
|
|
||
| ## How It Works | ||
|
|
||
| When contributors open pull requests, Promptless analyzes the changes and suggests documentation updates. Since open source projects typically can't install GitHub apps with write access, Promptless uses a fork-based approach: | ||
|
|
||
| 1. Promptless maintains a fork of your documentation repository | ||
| 2. When documentation updates are needed, the `promptless-for-oss` service account creates a PR from that fork to your upstream repository | ||
| 3. You review and merge the PR just like any other community contribution | ||
|
Contributor
Author
There was a problem hiding this comment. Citation: Screenshot from #all-promptless shows the "Connect GitHub (OSS)" button and description: "Read-only app for open source repos. PRs are created via fork." |
||
|
|
||
| Documentation PRs appear in your repository alongside other contributor PRs, maintaining full visibility for your maintainer team. | ||
|
|
||
| ## Getting Started | ||
|
|
||
| <Steps> | ||
| <Step title="Create an account"> | ||
| Sign up at [accounts.gopromptless.ai](https://accounts.gopromptless.ai) | ||
| </Step> | ||
|
|
||
| <Step title="Connect GitHub (OSS)"> | ||
| On the [integrations page](https://app.gopromptless.ai/integrations), find the **GitHub (OSS)** card and click **Connect GitHub (OSS)**. This installs a read-only GitHub app that monitors your repositories without requiring write access. | ||
| </Step> | ||
|
|
||
| <Step title="Select your repositories"> | ||
| Choose which open source repositories you want Promptless to monitor for documentation updates. | ||
| </Step> | ||
|
|
||
| <Step title="Set up a doc collection"> | ||
| Tell Promptless where your documentation lives by creating a doc collection. This could be a `/docs` folder in the same repo, a separate docs repository, or a documentation platform like Fern or Docusaurus. See [Doc Collections](/docs/configuration/doc-collections) for details. | ||
| </Step> | ||
| </Steps> | ||
|
|
||
| Once configured, Promptless monitors your selected repositories. When a PR is opened, it analyzes the changes and opens a documentation PR from a fork if updates are needed. | ||
|
|
||
| ## Questions? | ||
|
|
||
| Contact us at help@gopromptless.ai—we're happy to help get your project set up. | ||
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
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
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.
There was a problem hiding this comment.
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-ossservice account, and Promptless-managed fork approach.View source