Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions fern/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,8 @@ navigation:
path: ./docs/getting-started.mdx
- page: Core Concepts
path: ./docs/core-concepts.mdx
- page: How Promptless Learns Your Docs
path: ./docs/doc-analysis.mdx
- page: Promptless for Open-Source
slug: promptless-oss
path: ./docs/open-source.mdx
Expand Down
37 changes: 37 additions & 0 deletions fern/docs/doc-analysis.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
Copy link
Contributor Author

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

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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.
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.


## 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
Copy link
Contributor

Choose a reason for hiding this comment

The 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.