No documentation for the Live Preview feature

[EstherChristopher]

What is the live preview feature?

The live preview is an accessibility feature that allows the editors to see their changes in real-time during the editing process.

Why should it be documented?

Creating documentation for this feature will help the users understand how to use the feature effectively. It will also help them understand how the feature works. In case they have issues with the live preview feature, they can reference the documentation to troubleshoot.

How it should be documented

The Live Preview feature should be explained, highlighting its benefit
An explanation of how it works
A step-by-step guide on how to use it

[EstherChristopher]

Proposed documentation for the Live Preview feature

The live preview is an accessibility feature that allows the editors to see their changes in real time during the editing process. It provides an immediate view of your content while in editing mode. It is also a more efficient approach to writing because it eliminates the need to switch often between editing and preview mode. The users also have the advantage of seeing errors and layout arrangements on the go.

How the Live feature works

• As you make edits to your content page, a window by the side will display all your changes in real time. It gives you an idea of how the final version will look

• You will immediately get an update whenever you change or modify the content

• The live preview window is interactive so you can interact with it, see that links work, etc. However, all changes have to be made to the content page itself.

How to Use the Live Preview feature

• Click on the Preview button to get a live preview. Your edits will be displayed to show how your final content will appear

• You can also close the live preview panel by clicking on the close button. To get your preview again, click on the preview button

[EstherChristopher]

PS: This is a rough draft showing the shape the actual documentation of the Live preview feature can take pending when I can access the Wagtail editor CMS.