-
Notifications
You must be signed in to change notification settings - Fork 1
docs: Add Promptless for Open Source quickstart guide #230
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
f3cab08
docs: Add publication dates to all blog posts (#227)
promptless[bot] 8519588
docs: Use subtitle frontmatter for blog post publication dates (#228)
promptless[bot] 4207d0c
Add Promptless for Open Source quickstart guide
promptless[bot] 93169b6
improved
prithvi2206 4d0257f
Sync documentation updates
promptless[bot] 53501c4
improve
prithvi2206 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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,70 @@ | ||
| --- | ||
| 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> | ||
|
|
||
|
|
||
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