Skip to content

docs: Clarify that Promptless analyzes only PR diffs, not entire codebases #173

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.

Sign up for GitHub

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
prithvi2206 merged 1 commit into from
Dec 20, 2025
Merged

docs: Clarify that Promptless analyzes only PR diffs, not entire codebases #173

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 6 additions & 0 deletions fern/docs/core-concepts/triggers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,12 @@ During analysis, Promptless processes information such as the code diff, PR titl

You can configure specific directories to monitor, focusing documentation efforts on relevant parts of your codebase.

#### What Gets Analyzed

When a PR triggers Promptless, we only analyze the files that changed in that PR. We don't search your entire repository—just the specific files shown in the diff.

This focused approach means Promptless understands exactly what's changing and generates accurate documentation updates based on those specific changes.

<AccordionGroup>
<Accordion title="Auto-publish Mode">
When auto-publish is enabled for your project:
Expand Down
4 changes: 4 additions & 0 deletions fern/docs/faq.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,10 @@ However, you can optionally enable **passive listening** for specific channels.

For more details, see our [Slack Integration documentation](/docs/integrations/slack-integration) and [Working with Slack](/docs/features/slack-interactions#4-passive-channel-listening).

### Does Promptless analyze my entire codebase?

No. When triggered by a pull request, Promptless only analyzes the changed files in the PR diff—it doesn't search across your entire repository. This focused approach helps Promptless understand exactly what changed and generate relevant documentation updates.

### How does Promptless handle my data?

Promptless follows strict data handling practices:
Expand Down