Skip to content

Commit f8dcf03

Browse files
committed
Sync Ask the Docs capitalization and documentation
1 parent 64a12ae commit f8dcf03

13 files changed

Lines changed: 42 additions & 41 deletions

‎AGENTS.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ Verify a change by building the zip and loading the classes from the extracted t
129129
| `includes/blocks/` | 8 free Gutenberg blocks (React in `src/`, compiled to `build/`) |
130130
| `includes/pro/` | Premium features: custom permalinks, rating system, help widget, KB homepage mode, floating TOC, docs layout, term featured images, export/import (Markdown/SQL/XLSX), GitHub import |
131131
| `includes/pro/blocks/` | 3 pro Gutenberg blocks: rating, toc, section-tree (React in `src/`, compiled to `build/`) |
132-
| `includes/pro/ai/` | Ask the docs (WordPress 7.0+ AI Client only): settings tab, retriever, prompt service, `POST /wzkb/v1/ask`, usage limits, answer cache, search box and Help widget front end, question log and Content gaps report, `knowledgebase/ask` ability. User docs in the free repo's `docs/` (`ask-the-docs.md`, `ask-the-docs-developer-reference.md`) |
132+
| `includes/pro/ai/` | Ask the Docs (WordPress 7.0+ AI Client only): settings tab, retriever, prompt service, `POST /wzkb/v1/ask`, usage limits, answer cache, search box and Help widget front end, question log and Content gaps report, `knowledgebase/ask` ability. User docs in the free repo's `docs/` (`ask-the-docs.md`, `ask-the-docs-developer-reference.md`) |
133133
| `includes/pro/github/` | GitHub Markdown import: API wrapper, content converter, import processor, webhook handler, import wizard, link rewriter |
134134
| `includes/pro/widgets/` | 2 pro classic widgets: TOC, Section Tree |
135135
| `includes/rest/` | REST API under `/wzkb/v1/` namespace |

‎CLAUDE.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ Verify a change by building the zip and loading the classes from the extracted t
129129
| `includes/blocks/` | 8 free Gutenberg blocks (React in `src/`, compiled to `build/`) |
130130
| `includes/pro/` | Premium features: custom permalinks, rating system, help widget, KB homepage mode, floating TOC, docs layout, term featured images, export/import (Markdown/SQL/XLSX), GitHub import |
131131
| `includes/pro/blocks/` | 3 pro Gutenberg blocks: rating, toc, section-tree (React in `src/`, compiled to `build/`) |
132-
| `includes/pro/ai/` | Ask the docs (WordPress 7.0+ AI Client only): settings tab, retriever, prompt service, `POST /wzkb/v1/ask`, usage limits, answer cache, search box and Help widget front end, question log and Content gaps report, `knowledgebase/ask` ability. User docs in the free repo's `docs/` (`ask-the-docs.md`, `ask-the-docs-developer-reference.md`) |
132+
| `includes/pro/ai/` | Ask the Docs (WordPress 7.0+ AI Client only): settings tab, retriever, prompt service, `POST /wzkb/v1/ask`, usage limits, answer cache, search box and Help widget front end, question log and Content gaps report, `knowledgebase/ask` ability. User docs in the free repo's `docs/` (`ask-the-docs.md`, `ask-the-docs-developer-reference.md`) |
133133
| `includes/pro/github/` | GitHub Markdown import: API wrapper, content converter, import processor, webhook handler, import wizard, link rewriter |
134134
| `includes/pro/widgets/` | 2 pro classic widgets: TOC, Section Tree |
135135
| `includes/rest/` | REST API under `/wzkb/v1/` namespace |

‎docs/01-kb-getting-started/ask-the-docs.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
slug: ask-the-docs
3-
title: "Ask the docs: AI answers from your knowledge base"
3+
title: "Ask the Docs: AI answers from your knowledge base"
44
products: [knowledgebase]
55
sections: ["01-kb-getting-started"]
66
tags: [ai, knowledgebase, pro, search]
@@ -11,31 +11,31 @@ toc: true
1111

1212
[toc]
1313

14-
**Ask the docs** in [Knowledge Base Pro](https://webberzone.com/plugins/knowledgebase/) answers a visitor's plain-language question from your published articles, with links to the articles it used. When your articles don't cover the question, it says so, points to the search results and, optionally, logs the question so you can see where your documentation falls short. Ask the docs is in beta.
14+
**Ask the Docs** in [Knowledge Base Pro](https://webberzone.com/plugins/knowledgebase/) answers a visitor's plain-language question from your published articles, with links to the articles it used. When your articles don't cover the question, it says so, points to the search results and, optionally, logs the question so you can see where your documentation falls short. Ask the Docs is in beta.
1515

1616
## Requirements
1717

1818
- Knowledge Base Pro 3.2.0 or later.
19-
- WordPress 7.0 or later. Ask the docs uses the AI Client built into WordPress 7.0. On older versions the feature does not load and the rest of the plugin works as before.
19+
- WordPress 7.0 or later. Ask the Docs uses the AI Client built into WordPress 7.0. On older versions the feature does not load and the rest of the plugin works as before.
2020
- An AI provider connected under **Settings → Connectors**, such as the official Anthropic, OpenAI or Google provider plugins. It must support text generation with structured JSON output.
2121

2222
Knowledge Base Pro never sees or stores API keys. WordPress sends each request through the provider you have connected, which bills you per request.
2323

24-
## Set up Ask the docs
24+
## Set up Ask the Docs
2525

2626
1. Connect a provider under **Settings → Connectors**.
27-
2. Go to **Knowledge Base → Settings → AI (Beta)** and turn on **Enable Ask the docs**. If the tab says no AI provider is configured, the provider isn't set up yet or doesn't support structured answers.
27+
2. Go to **Knowledge Base → Settings → AI (Beta)** and turn on **Enable Ask the Docs**. If the tab says no AI provider is configured, the provider isn't set up yet or doesn't support structured answers.
2828
3. Set the **Daily request cap** and **Questions per visitor per hour** to fit your provider budget.
2929

30-
Ask the docs then answers in every knowledge base search box (the Knowledge Base Search block, the `[[kbsearch]]` shortcode and the knowledge base templates) and in the [Help widget](https://webberzone.com/support/knowledgebase/knowledge-base-help-widget/). Live search suggestions still appear while typing; pressing Enter or the search button asks the question. Without JavaScript, or when no provider is available, the search box submits to the knowledge base search results as usual.
30+
Ask the Docs then answers in every knowledge base search box (the Knowledge Base Search block, the `[[kbsearch]]` shortcode and the knowledge base templates) and in the [Help widget](https://webberzone.com/support/knowledgebase/knowledge-base-help-widget/). Live search suggestions still appear while typing; pressing Enter or the search button asks the question. Without JavaScript, or when no provider is available, the search box submits to the knowledge base search results as usual.
3131

3232
## Settings
3333

3434
All settings are under **Knowledge Base → Settings → AI (Beta)**.
3535

3636
| Setting | Default | What it does |
3737
| --- | --- | --- |
38-
| **Enable Ask the docs** | Off | Turns the feature on. |
38+
| **Enable Ask the Docs** | Off | Turns the feature on. |
3939
| **AI provider** | Automatic | The connected provider that answers. Automatic lets WordPress choose, and is used if the chosen provider's plugin is deactivated. |
4040
| **Articles sent as context** | `4` | Matching articles sent with each question, from 1 to 8. More articles improve coverage but cost more. |
4141
| **Maximum characters per article** | `3000` | Each article is trimmed to this length before it is sent, from 500 to 10,000. |
@@ -76,7 +76,7 @@ If no articles match, no request is sent.
7676

7777
**Each visitor gets a fixed number of questions per hour.** Once a visitor reaches it, their questions go to the search results with no error shown.
7878

79-
**The daily cap switches Ask the docs off** until the next day in your site's time zone. Search boxes then work as plain search forms.
79+
**The daily cap switches Ask the Docs off** until the next day in your site's time zone. Search boxes then work as plain search forms.
8080

8181
**Requests must come from your site and a browser.** Requests from other sites, bots and scripts are refused before any provider request. See [Bot check](https://webberzone.com/support/knowledgebase/ask-the-docs-developer-reference/) in the developer reference. A determined script can fake both, so the daily cap remains the limit on cost.
8282

@@ -105,6 +105,6 @@ Each row links to a new article with the question as its title, and to the knowl
105105

106106
## See also
107107

108-
- [Ask the docs developer reference](https://webberzone.com/support/knowledgebase/ask-the-docs-developer-reference/)
108+
- [Ask the Docs developer reference](https://webberzone.com/support/knowledgebase/ask-the-docs-developer-reference/)
109109
- [Knowledge Base Pro Help Widget](https://webberzone.com/support/knowledgebase/knowledge-base-help-widget/)
110110
- [Live Search](https://webberzone.com/support/knowledgebase/live-search/)

‎docs/01-kb-getting-started/free-vs-pro-knowledge-base.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ status: publish
88
order: 0
99
---
1010

11-
Knowledge Base is free to use. The Pro upgrade adds AI answers from your articles (Ask the docs), article ratings and feedback, a floating help widget, a three-column documentation layout, a custom permalinks engine, premium layouts, and GitHub-based content sync for larger documentation sites.
11+
Knowledge Base is free to use. The Pro upgrade adds AI answers from your articles (Ask the Docs), article ratings and feedback, a floating help widget, a three-column documentation layout, a custom permalinks engine, premium layouts, and GitHub-based content sync for larger documentation sites.
1212

1313
## Free vs Pro
1414

@@ -47,7 +47,7 @@ Knowledge Base is free to use. The Pro upgrade adds AI answers from your article
4747
| Floating help widget with live search and suggested articles | ❌ | ✅ |
4848
| Help widget contact form with email notifications | ❌ | ✅ |
4949
| **AI (Beta, WordPress 7.0+)** | | |
50-
| Ask the docs: AI answers from your articles in search boxes and the Help widget | ❌ | ✅ |
50+
| Ask the Docs: AI answers from your articles in search boxes and the Help widget | ❌ | ✅ |
5151
| Source and related article links with each answer | ❌ | ✅ |
5252
| Answer caching, per-visitor limits and a daily request cap | ❌ | ✅ |
5353
| Content gaps report of unanswered questions, with CSV export | ❌ | ✅ |

‎docs/01-kb-getting-started/knowledge-base-help-widget.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ toc: true
1111

1212
[toc]
1313

14-
The **Help Widget** in [Knowledge Base Pro](https://webberzone.com/plugins/knowledgebase/) is a floating button that opens a help panel on your site. Visitors can search your knowledge base, browse suggested articles, get an AI answer with [Ask the docs](https://webberzone.com/support/knowledgebase/ask-the-docs/), or send you a message, without leaving the page.
14+
The **Help Widget** in [Knowledge Base Pro](https://webberzone.com/plugins/knowledgebase/) is a floating button that opens a help panel on your site. Visitors can search your knowledge base, browse suggested articles, get an AI answer with [Ask the Docs](https://webberzone.com/support/knowledgebase/ask-the-docs/), or send you a message, without leaving the page.
1515

1616
## Set up the Help Widget
1717

@@ -34,9 +34,9 @@ Go to **Knowledge Base → Settings → Pro** and turn on **Enable Help Widget**
3434

3535
The panel follows the visitor's light or dark mode preference, works with the keyboard and screen readers, and supports right-to-left languages.
3636

37-
## Ask the docs in the Help Widget
37+
## Ask the Docs in the Help Widget
3838

39-
With Ask the docs enabled and **Use in the Help widget** turned on under **Knowledge Base → Settings → AI (Beta)**:
39+
With Ask the Docs enabled and **Use in the Help widget** turned on under **Knowledge Base → Settings → AI (Beta)**:
4040

4141
- Typing still shows matching articles.
4242
- Pressing Enter or the search button also shows a short answer above the articles, with its sources and related articles.

‎docs/01-kb-getting-started/knowledge-base-settings.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ How long should the knowledge base be cached for? Default is 1 day.
9696

9797
#### Clearing the cache
9898

99-
To clear the cache, go to **Knowledge Base → Tools** and click **Clear Cache**, or click **Clear cache** next to **Save Changes** on the settings page (Pro only). Both clear the knowledge base output cache and cached REST API responses. In Pro, they also clear cached [Ask the docs](https://webberzone.com/support/knowledgebase/ask-the-docs/) answers.
99+
To clear the cache, go to **Knowledge Base → Tools** and click **Clear Cache**, or click **Clear cache** next to **Save Changes** on the settings page (Pro only). Both clear the knowledge base output cache and cached REST API responses. In Pro, they also clear cached [Ask the Docs](https://webberzone.com/support/knowledgebase/ask-the-docs/) answers.
100100

101101
### Uninstall options
102102

@@ -444,11 +444,11 @@ Enable a subtle pulsing animation on the help widget button to draw attention. D
444444

445445
## AI (Beta) *(Pro only)*
446446

447-
Settings for [Ask the docs](https://webberzone.com/support/knowledgebase/ask-the-docs/), which answers visitors' questions from your knowledge base using the AI provider connected under **Settings → Connectors**. This tab appears on WordPress 7.0 or later.
447+
Settings for [Ask the Docs](https://webberzone.com/support/knowledgebase/ask-the-docs/), which answers visitors' questions from your knowledge base using the AI provider connected under **Settings → Connectors**. This tab appears on WordPress 7.0 or later.
448448

449449
| Setting | Default | Description |
450450
| --- | --- | --- |
451-
| **Enable Ask the docs** | Off | Turns the feature on. |
451+
| **Enable Ask the Docs** | Off | Turns the feature on. |
452452
| **AI provider** | Automatic | Which connected provider answers questions. |
453453
| **Articles sent as context** | 4 | Matching articles sent with each question (1–8). |
454454
| **Maximum characters per article** | 3,000 | Each article is trimmed to this length before it is sent (500–10,000). |
@@ -462,4 +462,4 @@ Settings for [Ask the docs](https://webberzone.com/support/knowledgebase/ask-the
462462
| **Record questions for Content gaps** | Off | Store question text for the Content gaps report. |
463463
| **Log retention (days)** | 90 | How long recorded questions are kept (1–3,650). |
464464

465-
See [Ask the docs](https://webberzone.com/support/knowledgebase/ask-the-docs/#settings) for details on each setting.
465+
See [Ask the Docs](https://webberzone.com/support/knowledgebase/ask-the-docs/#settings) for details on each setting.

‎docs/01-kb-getting-started/live-search.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ As soon as the visitor types in the KB search box, an AJAX request fetches match
2727
- **Accessible** — results are announced to screen readers via an ARIA live region.
2828
- **Debounced** — requests fire after a short pause while typing, not on every keystroke.
2929

30-
With [Ask the docs](https://webberzone.com/support/knowledgebase/ask-the-docs/) *(Pro)* turned on, suggestions still appear while typing. Pressing Enter with no suggestion highlighted asks the question instead of opening the search results.
30+
With [Ask the Docs](https://webberzone.com/support/knowledgebase/ask-the-docs/) *(Pro)* turned on, suggestions still appear while typing. Pressing Enter with no suggestion highlighted asks the question instead of opening the search results.
3131

3232
## Better Search
3333

@@ -56,6 +56,6 @@ If suggestions use the wrong language, check your translation plugin’s configu
5656

5757
## See also
5858

59-
- [Ask the docs](https://webberzone.com/support/knowledgebase/ask-the-docs/) — AI answers in the search box *(Pro)*
59+
- [Ask the Docs](https://webberzone.com/support/knowledgebase/ask-the-docs/) — AI answers in the search box *(Pro)*
6060
- [Knowledge Base Settings](https://webberzone.com/support/knowledgebase/knowledge-base-settings/) — Output settings reference
6161
- [Knowledge Base Shortcodes](https://webberzone.com/support/knowledgebase/knowledge-base-shortcodes/) — `[[kbsearch]]` shortcode

‎docs/03-kb-developer-docs/ask-the-docs-developer-reference.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
slug: ask-the-docs-developer-reference
3-
title: "Ask the docs developer reference"
3+
title: "Ask the Docs developer reference"
44
products: [knowledgebase]
55
sections: ["03-kb-developer-docs"]
66
tags: [ai, developer, knowledgebase, pro, rest-api]
@@ -11,9 +11,9 @@ toc: true
1111

1212
[toc]
1313

14-
This reference covers the REST endpoint, the Abilities API ability, and the filters and actions behind **Ask the docs** in [Knowledge Base Pro](https://webberzone.com/plugins/knowledgebase/). For setup and settings, see [Ask the docs: AI answers from your knowledge base](https://webberzone.com/support/knowledgebase/ask-the-docs/).
14+
This reference covers the REST endpoint, the Abilities API ability, and the filters and actions behind **Ask the Docs** in [Knowledge Base Pro](https://webberzone.com/plugins/knowledgebase/). For setup and settings, see [Ask the Docs: AI answers from your knowledge base](https://webberzone.com/support/knowledgebase/ask-the-docs/).
1515

16-
Ask the docs needs WordPress 7.0 or later. On older versions none of these hooks, routes or abilities are registered.
16+
Ask the Docs needs WordPress 7.0 or later. On older versions none of these hooks, routes or abilities are registered.
1717

1818
## REST endpoint
1919

@@ -47,7 +47,7 @@ Questions must be 3 to 300 characters after HTML tags are stripped and whitespac
4747
| 400 | `wzkb_ai_invalid_question` | The question is too short or too long. |
4848
| 403 | `wzkb_ai_forbidden_origin` | The `Origin` (or `Referer`) header doesn't match the site or an allowed origin. |
4949
| 403 | `wzkb_ai_forbidden_client` | The request has no user agent, or one that looks like a bot, script or HTTP library. |
50-
| 404 | `wzkb_ai_unavailable` | Ask the docs is disabled or no provider is available. |
50+
| 404 | `wzkb_ai_unavailable` | Ask the Docs is disabled or no provider is available. |
5151
| 429 | `wzkb_ai_rate_limited` | The visitor reached **Questions per visitor per hour**. The `Retry-After` header gives the seconds until the next hour. |
5252

5353
When the daily cap is reached, the endpoint returns 200 with `answered` set to `false` and `reason` set to `daily_cap`.
@@ -78,7 +78,7 @@ add_filter(
7878

7979
## Ability
8080

81-
Knowledge Base Pro registers the `knowledgebase/ask` ability with the WordPress Abilities API, in the shared `webberzone` category. It takes `{ "question": "..." }`, returns the same data as the REST endpoint, and runs through the same cache and limits. It is registered only on WordPress 7.0 or later, where Ask the docs loads.
81+
Knowledge Base Pro registers the `knowledgebase/ask` ability with the WordPress Abilities API, in the shared `webberzone` category. It takes `{ "question": "..." }`, returns the same data as the REST endpoint, and runs through the same cache and limits. It is registered only on WordPress 7.0 or later, where Ask the Docs loads.
8282

8383
It is limited to logged-in users by default, because the Abilities API route cannot check that a request comes from your site the way the REST endpoint does. The bot check does not apply to it. Use `wzkb_ai_ability_permission` to change who can run it:
8484

@@ -140,7 +140,7 @@ add_filter(
140140
| Action | Arguments | Description |
141141
| --- | --- | --- |
142142
| `wzkb_ai_question_asked` | `string $question`, `array $result`, `bool $cached` | Fires after each answered or unanswered question. |
143-
| `wzkb_cache_cleared` | None | Fires after **Knowledge Base → Tools → Clear Cache** clears the output cache. Knowledge Base uses it to invalidate REST API responses, and Knowledge Base Pro to delete cached Ask the docs answers. |
143+
| `wzkb_cache_cleared` | None | Fires after **Knowledge Base → Tools → Clear Cache** clears the output cache. Knowledge Base uses it to invalidate REST API responses, and Knowledge Base Pro to delete cached Ask the Docs answers. |
144144

145145
```php
146146
add_action(
@@ -159,6 +159,6 @@ add_action(
159159

160160
## See also
161161

162-
- [Ask the docs: AI answers from your knowledge base](https://webberzone.com/support/knowledgebase/ask-the-docs/)
162+
- [Ask the Docs: AI answers from your knowledge base](https://webberzone.com/support/knowledgebase/ask-the-docs/)
163163
- [Knowledge Base Abilities API](https://webberzone.com/support/knowledgebase/knowledge-base-abilities-api/)
164164
- [Knowledge Base REST API](https://webberzone.com/support/knowledgebase/knowledge-base-rest-api/)

0 commit comments

Comments
 (0)