-
Notifications
You must be signed in to change notification settings - Fork 1
docs: Add "How Promptless Learns Your Docs" page explaining doc analysis #248
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
5 commits
Select commit
Hold shift + click to select a range
c5c0d01
Add "How Promptless Learns Your Docs" page explaining doc analysis
promptless[bot] 4a1cbfb
Sync documentation updates
promptless[bot] ea766c0
Sync documentation updates
promptless[bot] 7b4e532
Sync documentation updates
promptless[bot] eb02014
Sync documentation updates
promptless[bot] 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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,37 @@ | ||||||
| --- | ||||||
| title: How Promptless Learns Your Docs | ||||||
| --- | ||||||
|
|
||||||
| Before creating the first suggestion, Promptless analyzes your existing docs to understand the product, writing style, and how your docs are organized. | ||||||
|
|
||||||
| ## Initial Ingestion | ||||||
|
|
||||||
| - Builds a searchable index to find relevant content when analyzing triggers | ||||||
| - Maps relationships between pages, sections, and topics | ||||||
|
|
||||||
| ## Product Ontology | ||||||
|
|
||||||
| Promptless builds an understanding of your product's structure—what features you have, how they relate to each other, and the terminology your team uses. This **product ontology** helps Promptless: | ||||||
|
|
||||||
| - Know which documentation pages are relevant when a specific feature changes | ||||||
| - Understand your product's concepts and terminology | ||||||
| - Identify connections between features that might require coordinated documentation updates | ||||||
|
|
||||||
| For example, if your product has a "Workspaces" feature with sub-features like "Permissions" and "Invitations," Promptless understands these relationships and can update all relevant pages when workspace behavior changes. | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
|
||||||
| ## Voice and Style Learning | ||||||
|
|
||||||
| Promptless analyzes how your documentation is written—tone, sentence structure, formatting patterns, and terminology choices. This powers **Voice Match**, ensuring suggestions sound like they were written by your team. | ||||||
|
|
||||||
| Promptless learns patterns like: | ||||||
|
|
||||||
| - Whether you write formally or conversationally | ||||||
| - The specific words and phrases you use for concepts | ||||||
| - How you organize content, use headings, and format examples | ||||||
| - Your preferences for capitalization, punctuation, and code formatting | ||||||
|
|
||||||
| When drafting content, Promptless references similar existing pages to match their style. | ||||||
|
|
||||||
| ## Continuous Learning | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This doesn't make sense as a section in this doc either |
||||||
|
|
||||||
| Promptless continues learning as you use it. When you edit suggestions or provide feedback, Promptless learns your preferences for future suggestions. As your documentation grows and changes, Promptless adapts to your evolving style and automatically re-indexes when you publish updates to stay current. | ||||||
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: Frances requested documentation about "what happens during doc analysis" including the product ontology. This new page addresses those topics: product ontology building, voice/style learning, and what happens when triggers fire.
View source