Efficiently Using the Empress Documentation Editing Feature: A Guide for Developers

Developers
1

Introduction

Welcome to the comprehensive guide on the Empress Documentation Editing Feature. This feature is fundamental to the functionality of Empress, playing a crucial role in managing and modifying the documentation of your software. This guide will take you through each step of the process, providing detailed explanations and code to make the task as smooth as possible.

Understanding the Editing Feature

The Empress Documentation Editing Feature stores all pages of the documentation website in the database, allowing for edits whenever required. This inherent flexibility enables developers to maintain up-to-date and accurate documentation, vital for seamless software development and customization.

Step-by-Step Guide

Identifying the Page for Edit

  1. Navigate to the page you want to modify.

Entering the Editing Mode

  1. Scroll to the bottom of the page and click on the edit button.

Editing the Markdown Code

  1. Upon clicking the Edit button, a user interface will appear for editing the markdown code.

  2. You can preview your changes in real-time on the Preview Tab.

Switching to the WYSIWYG Editor

  1. If you prefer not to edit markdown and would like to use the WYSIWYG Editor, click on the switcher and select ‘Rich-Text’.

Uploading Images

  1. For image uploads, the process differs slightly between Markdown and WYSIWYG modes:

  • In Markdown mode:

    1. Click on ‘Add Attachment’ to upload an image.
    2. Use the ‘Copy Link’ button to copy the image link.
    3. Paste the link into the editor to display the image.

  • In WYSIWYG editor:

    1. Paste a copied image.
    2. Drag and drop an image.
    3. Use the image button at the top of the editor.

Submitting the Changes

  1. After editing, click on the ‘Submit’ button and wait for your changes to be submitted.

Reviewing the Submission

  1. Post submission, a screen will appear that allows you to track your contributions and wait for a reviewer to approve, reject, or request changes.

  2. Click on ‘Open Contribution’ to continue your work or use the comment system to communicate with the reviewer.

Adding New Pages

  1. If you want to create a new page instead of editing, you will find the ‘New Page’ link at the bottom of the Left Sidebar. The process from here is similar to editing.

Sidebar Rearrangement

  1. On the edit/new page, you can rearrange sidebars by drag and drop method. However, this option should be used sparingly.

Conclusion

The Empress Documentation Editing Feature is a powerful tool for developers, enabling dynamic documentation management. By understanding and effectively using this feature, developers can ensure accurate, up-to-date documentation, critical for successful software development and customization. Happy Coding!