docs: Clarify that context sources are read-only#341
Open
promptless[bot] wants to merge 1 commit intomainfrom
Open
docs: Clarify that context sources are read-only#341promptless[bot] wants to merge 1 commit intomainfrom
promptless[bot] wants to merge 1 commit intomainfrom
Conversation
promptless
bot
requested review from
adit-chandra,
frances720,
mattlink and
prithvi2206
as code owners
![promptless[bot]](https://avatars.githubusercontent.com/in/979718?s=60&v=4){kind=small}
| Context sources are integrations that give Promptless **read-only** access to your organization's existing tools and data. They provide additional context that helps Promptless create more accurate and comprehensive documentation suggestions. | ||
|
|
||
| <Info> | ||
| Context sources are **one-way**: Promptless reads information from these services to inform documentation updates, but never writes back to them. Your Jira tickets, Linear issues, and Confluence pages remain unchanged. |
Contributor
Author
There was a problem hiding this comment.
User feedback in #dogfood about confusion thinking Promptless updates context sources like Jira
Source: https://Promptless.slack.com/archives/C08RZNK94GN/p1774543991616249
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
|
@Promptless are you able to fixup the commit history on this PR so that there is only a single commit with the intended changes? |
Add explicit language across all context source pages making clear that Promptless only reads from these services and never writes back to them. This addresses user confusion about whether Promptless updates Jira/Linear tickets or Confluence pages. Changes: - Added prominent Info callout on main Context Sources page stating context sources are "one-way"—Promptless reads but never writes - Updated intro paragraphs on Jira, Confluence, and Linear pages to explicitly state "read-only" access - Added clarifying sentences to Data Privacy sections on each page
promptless
bot
force-pushed
the
promptless/clarify-context-sources-read-only
branch
from
0e912c0 to
eb26955
Compare
Contributor
Author
|
Done! I've squashed the commit history down to a single commit with a clean, descriptive message. The PR now shows just the one content commit instead of the 12 sync commits. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Open this suggestion in Promptless to view citations and reasoning process
Adds explicit language across all context source documentation pages making clear that Promptless only reads from these services (Jira, Linear, Confluence) and never writes back to them. This addresses user confusion about whether Promptless updates Jira tickets or other context sources.
Changes:
Why users were confused:
write:jira-workscope (required by Atlassian for API access), which may have suggested write capabilityFiles changed:
src/content/docs/docs/configuring-promptless/context-sources.mdxsrc/content/docs/docs/configuring-promptless/context-sources/jira.mdxsrc/content/docs/docs/configuring-promptless/context-sources/confluence.mdxsrc/content/docs/docs/configuring-promptless/context-sources/linear.mdx