PluginProbe
BetterDocs – AI Documentation, Knowledge Base, MCP Server, Docs, Wikis, FAQ & Chatbot / 4.2.0
BetterDocs – AI Documentation, Knowledge Base, MCP Server, Docs, Wikis, FAQ & Chatbot v4.2.0
4.9.1 4.9.0 4.8.2 4.8.1 4.8.0 4.7.0 4.6.2 4.6.1 4.6.0 4.5.6 4.5.5 4.5.4 4.5.3 4.5.2 4.5.1 4.5.0 4.4.1 4.4.0 3.3.4 3.4.0 3.4.1 3.4.2 3.5.0 3.5.1 3.5.2 All 199 releases
← All changes | includes/Core/SetupWizard.php +43 -187 4.9.04.2.0 View file →
@@ -1,12 +1,8 @@
1 1 <?php
2 +
2 3 namespace WPDeveloper\BetterDocs\Core;
3 4
4 -if ( ! defined( 'ABSPATH' ) ) {
5 - exit;
6 -}
7 -
8 -
9 5 use WPDeveloper\BetterDocs\Utils\Base;
10 6 use WPDeveloper\BetterDocs\Admin\Builder\Rules;
11 7 use WPDeveloper\BetterDocs\Admin\Builder\GlobalFields;
12 8
@@ -24,57 +20,13 @@
24 20 }
25 21
26 22 betterdocs()->assets->enqueue( 'betterdocs-quick-setup', 'admin/js/quick-setup.js' );
27 23 betterdocs()->assets->localize( 'betterdocs-quick-setup', 'betterdocsQuickSetup', GlobalFields::normalize( $this->quickbuilder_setup() ) );
28 - betterdocs()->assets->localize(
29 - 'betterdocs-quick-setup',
30 - 'betterdocsSampleDocs',
31 - [
32 - 'enabled' => (bool) $this->settings->get( 'enable_ai_sample_docs', true ),
33 - 'rest_url' => esc_url_raw( rest_url() ),
34 - 'rest_base' => esc_url_raw( get_rest_url( null, '/betterdocs/v1/sample-docs' ) ),
35 - 'nonce' => wp_create_nonce( 'wp_rest' ),
36 - ]
37 - );
38 - // The layout picker writes Customizer theme_mods, which a block (FSE) theme never
39 - // reads — so on FSE we don't offer the picker at all (and don't spend the work
40 - // building its groups). The Customize step shows the same "design it in the Site
41 - // Editor" card the Settings > Design tab already shows there instead.
42 - $is_fse = (bool) betterdocs()->helper->current_theme_is_fse_theme();
43 -
44 - betterdocs()->assets->localize(
45 - 'betterdocs-quick-setup',
46 - 'betterdocsCustomizeLayouts',
47 - [
48 - 'rest_url' => esc_url_raw( rest_url() ),
49 - 'rest_base' => esc_url_raw( get_rest_url( null, '/betterdocs/v1/customize' ) ),
50 - 'nonce' => wp_create_nonce( 'wp_rest' ),
51 - 'is_fse' => $is_fse,
52 - 'groups' => $is_fse ? [] : $this->customize_layout_groups(),
53 - 'fse' => [
54 - 'eyebrow' => __( 'Full Site Editing', 'betterdocs' ),
55 - 'title' => __( 'Design with the Gutenberg Site Editor', 'betterdocs' ),
56 - 'description' => __( 'BetterDocs ships editable templates and ready-made patterns for your documentation. Open the Site Editor to design them block by block — colors, typography and layout included.', 'betterdocs' ),
57 - 'features' => [
58 - __( 'Docs archive & category templates', 'betterdocs' ),
59 - __( 'Single doc layout', 'betterdocs' ),
60 - __( 'Ready-made BetterDocs patterns', 'betterdocs' ),
61 - ],
62 - 'button' => __( 'Design with Gutenberg', 'betterdocs' ),
63 - 'note' => __( 'Opens in a new tab, so you can finish setup here.', 'betterdocs' ),
64 - // Opens the Site Editor's template list filtered to BetterDocs, rather than
65 - // dropping the user straight into one template (what Settings::gutenberg_link()
66 - // does) — from the wizard they've not chosen a template to edit yet.
67 - // Built by concatenation on purpose: add_query_arg() would re-encode the %2F.
68 - 'url' => admin_url( 'site-editor.php?p=%2Ftemplate&activeView=BetterDocs' ),
69 - 'image' => betterdocs()->assets->icon( 'customizer/gutenberg-preview.png', true ),
70 - ],
71 - ]
72 - );
73 24 betterdocs()->assets->enqueue( 'betterdocs-sweetalert', 'vendor/js/sweetalert.min.js', [] );
74 25 betterdocs()->assets->enqueue( 'betterdocs-icons', 'admin/btd-icon/style.css' );
75 26 betterdocs()->assets->enqueue( 'betterdocs-setup-wizard-qb-css', 'admin/css/quick-setup.css' );
76 27 betterdocs()->assets->enqueue( 'betterdocs-setup-wizard-new-css', 'admin/css/setup-wizard.css' );
28 + betterdocs()->assets->enqueue( 'betterdocs-icons', 'admin//style.css' );
77 29 betterdocs()->assets->enqueue( 'betterdocs-setup-wizard-default-js', 'admin/js/setup-wizard.js', [ 'jquery', 'betterdocs-sweetalert' ] );
78 30
79 31 // Localize the script with new data
80 32 betterdocs()->assets->localize(
@@ -90,92 +42,8 @@
90 42 ]
91 43 );
92 44 }
93 45
94 - /**
95 - * Layout-picker groups for the interactive "Customize" step. Each group's
96 - * `current` reflects the saved theme_mod; only the free layouts are offered.
97 - *
98 - * @return array
99 - */
100 - private function customize_layout_groups() {
101 - $build = function ( $key, $default, $dir, $title, $hint, $cols, array $options ) {
102 - $out = [];
103 - foreach ( $options as $value => $label ) {
104 - $out[] = [
105 - 'value' => $value,
106 - 'label' => $label,
107 - 'image' => betterdocs()->assets->icon( "customizer/{$dir}/{$value}.png", true ),
108 - ];
109 - }
110 - return [
111 - 'title' => $title,
112 - 'hint' => $hint,
113 - 'cols' => $cols,
114 - 'key' => $key,
115 - 'current' => get_theme_mod( $key, $default ),
116 - 'options' => $out,
117 - ];
118 - };
119 -
120 - return [
121 - 'docs' => $build(
122 - 'betterdocs_docs_layout_select',
123 - 'layout-7',
124 - 'docs-page',
125 - __( 'Docs Page', 'betterdocs' ),
126 - __( 'The main knowledge-base landing page.', 'betterdocs' ),
127 - 4,
128 - [
129 - 'layout-7' => __( 'Sleek', 'betterdocs' ),
130 - 'layout-1' => __( 'Grid', 'betterdocs' ),
131 - 'layout-8' => __( 'Slate', 'betterdocs' ),
132 - 'layout-5' => __( 'Classic', 'betterdocs' ),
133 - ]
134 - ),
135 - 'category' => $build(
136 - 'betterdocs_archive_layout_select',
137 - 'layout-7',
138 - 'archive',
139 - __( 'Category Page', 'betterdocs' ),
140 - __( "Where a single category's articles live.", 'betterdocs' ),
141 - 4,
142 - [
143 - 'layout-7' => __( 'Sleek', 'betterdocs' ),
144 - 'layout-1' => __( 'Classic', 'betterdocs' ),
145 - 'layout-8' => __( 'Slate', 'betterdocs' ),
146 - 'layout-4' => __( 'Abstract', 'betterdocs' ),
147 - ]
148 - ),
149 - 'single' => $build(
150 - 'betterdocs_single_layout_select',
151 - 'layout-8',
152 - 'single',
153 - __( 'Single Doc', 'betterdocs' ),
154 - __( 'An individual article layout.', 'betterdocs' ),
155 - 4,
156 - [
157 - 'layout-8' => __( 'Essence', 'betterdocs' ),
158 - 'layout-9' => __( 'Rustic', 'betterdocs' ),
159 - 'layout-10' => __( 'Slate', 'betterdocs' ),
160 - 'layout-1' => __( 'Classic', 'betterdocs' ),
161 - ]
162 - ),
163 - 'search' => $build(
164 - 'betterdocs_search_layout_select',
165 - 'layout-2',
166 - 'search',
167 - __( 'Search', 'betterdocs' ),
168 - __( 'How visitors search your docs.', 'betterdocs' ),
169 - 4,
170 - [
171 - 'layout-2' => __( 'Modal', 'betterdocs' ),
172 - 'layout-1' => __( 'Classic', 'betterdocs' ),
173 - ]
174 - ),
175 - ];
176 - }
177 -
178 46 public function normalize_options( $options ) {
179 47 return GlobalFields::normalize_fields( $options );
180 48 }
181 49
@@ -221,19 +89,19 @@
221 89 'active' => 'getting-started',
222 90 'sidebar' => false,
223 91 'title' => false,
224 92 'tab_number' => true,
225 - 'clickable' => true,
93 + 'clickable' => false,
226 94 'completionTrack' => true,
227 95 'content_heading' => [],
228 96 'step' => [
229 97 'show' => true,
230 98 'buttons' => [
231 - 'skip' => __( 'Skip for now', 'betterdocs' ),
99 + 'skip' => __( 'Skip This Step', 'betterdocs' ),
232 100 'prev' => [
233 - 'name' => __( 'Back', 'betterdocs' ),
101 + 'name' => __( 'Previous', 'betterdocs' ),
234 102 'type' => 'customize',
235 - 'customName' => __( 'Back', 'betterdocs' ),
103 + 'customName' => __( 'Previous', 'betterdocs' ),
236 104 'condition' => 'getting-started',
237 105 ],
238 106 'start' => [
239 107 'name' => 'Start',
@@ -251,23 +119,18 @@
251 119 ],
252 120 'next' => [
253 121 'name' => 'Next',
254 122 'type' => 'customize',
255 - 'customName' => __( 'Save & Continue', 'betterdocs' ),
123 + 'customName' => __( 'Next', 'betterdocs' ),
256 124 'condition' => 'getting-started',
125 + ],
126 + 'quick-builder-publish' => [
127 + 'name' => 'quick-builder-publish',
128 + 'type' => 'action',
129 + 'action' => 'btd_quick_build_launch'
257 130 ]
258 131 ],
259 - // Hide the footer step bar on the first step (its CTA is in
260 - // content via showSteps) and on the last step (Finalize's
261 - // Finish CTA is in content too, so a lone Back button looked
262 - // off). Back-navigation there is still available via the tabs.
263 - 'rules' => Rules::logicalRule(
264 - [
265 - Rules::is( 'config.active', 'getting-started', true ),
266 - Rules::is( 'config.active', 'finalize', true ),
267 - ],
268 - 'and'
269 - )
132 + 'rules' => Rules::is( 'config.active', 'getting-started', true )
270 133 ]
271 134 ],
272 135 'submit' => [
273 136 'show' => false
@@ -288,9 +151,9 @@
288 151 'type' => 'header',
289 152 'title' => __( 'Quick Launch', 'betterdocs' ),
290 153 'direction' => 'column',
291 154 'description' => __( 'Start your Knowledge Base configuration process with an easy-to-follow setup wizard.', 'betterdocs' ),
292 - 'icon' => '<svg width="30" height="30" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.7" stroke-linecap="round" stroke-linejoin="round"><path d="M4.5 16.5c-1.5 1.26-2 5-2 5s3.74-.5 5-2c.71-.84.7-2.13-.09-2.91a2.18 2.18 0 0 0-2.91-.09z"></path><path d="M12 15l-3-3a22 22 0 0 1 2-3.95A12.88 12.88 0 0 1 22 2c0 2.72-.78 7.5-6 11a22.35 22.35 0 0 1-4 2z"></path><path d="M9 12H4s.55-3.03 2-4c1.62-1.08 5 0 5 0"></path><path d="M12 15v5s3.03-.55 4-2c1.08-1.62 0-5 0-5"></path></svg>',
155 + 'icon' => '<img src="' . betterdocs()->assets->icon( 'icons/rocket.svg', true ) . '"/>',
293 156 'priority' => 1
294 157 ],
295 158 'betterdocs-quick-setup-start' => [
296 159 'name' => 'betterdocs-quick-setup-start',
@@ -302,9 +165,9 @@
302 165 'name' => 'betterdocs-quick-setup-start-collapse',
303 166 'type' => 'collapse',
304 167 'priority' => 2,
305 168 'label' => __( 'By clicking this button, you are allowing this app to collect your information.', 'betterdocs' ),
306 - 'collapse_title' => __( 'What do we collect?', 'betterdocs' ),
169 + 'collapse_title' => __( 'What We Collect?', 'betterdocs' ),
307 170 'collapse_message' => __( 'We collect non-sensitive diagnostic data and plugin usage information. Your site URL, WordPress & PHP version, plugins & themes and email address to send you the discount coupon. This data lets us make sure this plugin always stays compatible with the most popular plugins and themes. No spam, we promise.', 'betterdocs' )
308 171 ]
309 172 ]
310 173 ]
@@ -325,9 +188,9 @@
325 188 'type' => 'header',
326 189 'title' => __( 'Page Setup Magic', 'betterdocs' ),
327 190 'direction' => 'row',
328 191 'description' => __( 'Configure the structure and layout of your documentation pages to match your preferences for an organized Knowledge Base.', 'betterdocs' ),
329 - 'icon' => '<svg width="30" height="30" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.7" stroke-linecap="round" stroke-linejoin="round"><path d="M15 8a1 1 0 0 1-1-1V2a2.4 2.4 0 0 1 1.704.706l3.588 3.588A2.4 2.4 0 0 1 20 8z"></path><path d="M20 8v12a2 2 0 0 1-2 2h-4.182"></path><path d="m3.305 19.53.923-.382"></path><path d="M4 10.592V4a2 2 0 0 1 2-2h8"></path><path d="m4.228 16.852-.924-.383"></path><path d="m5.852 15.228-.383-.923"></path><path d="m5.852 20.772-.383.924"></path><path d="m8.148 15.228.383-.923"></path><path d="m8.53 21.696-.382-.924"></path><path d="m9.773 16.852.922-.383"></path><path d="m9.773 19.148.922.383"></path><circle cx="7" cy="18" r="3"></circle></svg>',
192 + 'icon' => '<img src="' . betterdocs()->assets->icon( 'icons/content-setting.svg', true ) . '"/>',
330 193 'priority' => 1
331 194 ],
332 195 'betterdocs-quick-setup-fields' => [
333 196 'name' => 'betterdocs-quick-setup-fields',
@@ -340,13 +203,9 @@
340 203 'label' => __( 'Built-in Documentation Page', 'betterdocs' ),
341 204 'enable_disable_text_active' => true,
342 205 'default' => 1,
343 206 'priority' => 1,
344 - 'label_subtitle' => sprintf(
345 - /* translators: %s: example knowledge base URL */
346 - __( 'If you disable root slug for KB Archives, your individual knowledge base URL will be like this: %s', 'betterdocs' ),
347 - 'https://example.com/knowledgebase-1'
348 - )
207 + 'label_subtitle' => __( 'If you disable root slug for KB Archives, your individual knowledge base URL will be like this: https://example.com/knowledgebase-1', 'betterdocs' )
349 208 ],
350 209 'docs_page' => [
351 210 'name' => 'docs_page',
352 211 'label' => __( 'Docs Page', 'betterdocs' ),
@@ -466,14 +325,17 @@
466 325 'type' => 'header',
467 326 'title' => __( 'Content Crafting', 'betterdocs' ),
468 327 'direction' => 'row',
469 328 'description' => __( 'Craft categories & articles for your Knowledge Base to efficiently organize and manage your repository with respective categories.', 'betterdocs' ),
470 - 'icon' => '<svg width="30" height="30" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.7" stroke-linecap="round" stroke-linejoin="round"><path d="M4 4a1 1 0 0 1 1-1h9l5 5v3"></path><path d="M4 4v15a1 1 0 0 0 1 1h6"></path><path d="M14 3v5h5"></path><path d="M18.5 13.5a2.1 2.1 0 0 1 3 3L16 22l-4 1 1-4z"></path></svg>',
329 + 'icon' => '<img src="' . betterdocs()->assets->icon( 'icons/create-content.svg', true ) . '"/>',
471 330 'priority' => 1
472 331 ],
473 - 'create_content_generator' => [
474 - 'name' => 'create_content_generator',
475 - 'type' => 'sample_docs_generator',
332 + 'create_content_video' => [
333 + 'name' => 'create_content_video',
334 + 'type' => 'image',
335 + 'media' => [
336 + 'url' => betterdocs()->assets->icon( 'setup-wizard/DocCreate.gif', true )
337 + ],
476 338 'priority' => 2
477 339 ]
478 340 ]
479 341 ]
@@ -481,14 +343,9 @@
481 343 'customize' => apply_filters(
482 344 'betterdocs_quick_setup_tab_customize',
483 345 [
484 346 'id' => 'customize',
485 - // A block theme has no Customizer layouts to pick, so the step isn't
486 - // "Customize" there — it hands off to the Site Editor. (The tab id stays
487 - // `customize`: it keys the step's navigation and styling.)
488 - 'label' => betterdocs()->helper->current_theme_is_fse_theme()
489 - ? __( 'Design', 'betterdocs' )
490 - : __( 'Customize', 'betterdocs' ),
347 + 'label' => __( 'Customize', 'betterdocs' ),
491 348 'classes' => 'customize',
492 349 'priority' => 50,
493 350 'fields' => [
494 351 'customize_header' => [
@@ -493,24 +350,20 @@
493 350 'fields' => [
494 351 'customize_header' => [
495 352 'name' => 'customize_header',
496 353 'type' => 'header',
497 - 'title' => betterdocs()->helper->current_theme_is_fse_theme()
498 - ? __( 'Design Your Documentation', 'betterdocs' )
499 - : __( 'Style Your Documentation', 'betterdocs' ),
354 + 'title' => __( 'Style Your Documentation', 'betterdocs' ),
500 355 'direction' => 'row',
501 - // On a block theme the layout picker is replaced by the Site Editor
502 - // hand-off, so the copy leads with what the user CAN do rather than
503 - // naming a Customizer they will never open.
504 - 'description' => betterdocs()->helper->current_theme_is_fse_theme()
505 - ? __( 'Your theme supports Full Site Editing. Design your docs archive, single doc pages and patterns right in the Gutenberg Site Editor.', 'betterdocs' )
506 - : __( 'Pick a layout for your docs page, categories, single articles, and search — applied when you finish setup. Fine-tune the details anytime in the Customizer.', 'betterdocs' ),
507 - 'icon' => '<svg width="30" height="30" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.7" stroke-linecap="round" stroke-linejoin="round"><rect x="3" y="4" width="18" height="16" rx="2.5"></rect><path d="M3 9h18M9 9v11"></path></svg>',
356 + 'description' => __( 'Personalize the appearance of your documentation page, articles, and archive pages using the power of this Customizer.', 'betterdocs' ),
357 + 'icon' => '<img src="' . betterdocs()->assets->icon( 'icons/customize.svg', true ) . '"/>',
508 358 'priority' => 1
509 359 ],
510 - 'customize_layouts' => [
511 - 'name' => 'customize_layouts',
512 - 'type' => 'layout_customizer',
360 + 'customize_video' => [
361 + 'name' => 'customize_video',
362 + 'type' => 'image',
363 + 'media' => [
364 + 'url' => betterdocs()->assets->icon( 'setup-wizard/Customizer.gif', true )
365 + ],
513 366 'priority' => 2
514 367 ]
515 368 ]
516 369 ]
@@ -525,17 +378,20 @@
525 378 'fields' => [
526 379 'finalize_header' => [
527 380 'name' => 'finalize_header',
528 381 'type' => 'header',
529 - 'title' => __( 'One last step', 'betterdocs' ),
382 + 'title' => __( 'Congratulations!', 'betterdocs' ),
530 383 'direction' => 'row',
531 - 'description' => __( 'Review your setup below. When you\'re ready, finish to save your settings and apply BetterDocs across your site — you can change anything later in Settings.', 'betterdocs' ),
532 - 'icon' => '<svg width="30" height="30" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.7" stroke-linecap="round" stroke-linejoin="round"><path d="m3 17 2 2 4-4"></path><path d="m3 7 2 2 4-4"></path><path d="M13 6h8"></path><path d="M13 12h8"></path><path d="M13 18h8"></path></svg>',
384 + 'description' => __( 'Your documentation page is now ready for use. Enrich it with more articles to ensure proper categorization and valuable resources.', 'betterdocs' ),
385 + 'icon' => '<img src="' . betterdocs()->assets->icon( 'icons/thumbs-up.svg', true ) . '"/>',
533 386 'priority' => 1
534 387 ],
535 - 'finalize_finish' => [
536 - 'name' => 'finalize_finish',
537 - 'type' => 'finish_panel',
388 + 'finalize_video' => [
389 + 'name' => 'finalize_video',
390 + 'type' => 'image',
391 + 'media' => [
392 + 'url' => betterdocs()->assets->icon( 'setup-wizard/ThankYou.gif', true )
393 + ],
538 394 'priority' => 2
539 395 ]
540 396 ]
541 397 ]