Project Editing and Execution Management -> Edit project instructions

Edit project instructions

Summary

The Markdown Editor page allows you to create and manage text content using Markdown formatting. You can switch between an editor view for writing, a split view to see your changes in real-time alongside the editor, and a preview mode to see the final rendered output. The editor also features a search tool to help you find specific text. For your convenience, your work is automatically saved, and you'll receive notifications regarding your session status.

Page Access

You can access this page by navigating to: /automization

Page Functionalities

Text Editor

This is where you write your content. You can type freely, and the editor supports various Markdown formatting options (like headings, lists, and code blocks) to structure your text. If you need to find specific words or phrases, click the magnifying glass icon to open a search bar. Type your search term, and use the up/down arrows to jump between matches.

Save Button

If available, clicking the "Save" button will manually save your current work. You will see a small spinning circle while saving is in progress. The system also automatically saves your work periodically if you are actively using the editor.

View Modes

You can change how you view your content using the buttons at the top right:

  • Editor: Shows only the text editor, allowing you to focus purely on writing.
  • Split: Displays the text editor on one side and a live preview of your Markdown content on the other. You can drag the divider in the middle to adjust the size of each panel.
  • Preview: Shows only the rendered view of your Markdown content, letting you see exactly how it will appear without the editing interface.

Session Notifications

The system will notify you if your user session is about to expire, giving you time to save your work or extend your session. If your session does expire, you will be informed, and the editor will close to protect your data.

Scenario Executions

Possible usage steps within this page

Scenario 1: Writing and Saving Your First Draft

Imagine you want to create a new project description:

  1. You arrive at the Markdown Editor page.
  2. You start typing your project description in the main text area. For example: # My New Project\nThis project aims to automate tasks.
  3. You occasionally look at the "Split" or "Preview" mode to see how your headings and lists are formatted.
  4. When you're happy with your text, you click the "Save" button at the top right (if visible).
  5. A small spinning circle appears briefly, indicating your work is being saved.
  6. Once the spinning circle disappears, your description is saved, and you can continue editing or close the page.

Scenario 2: Reviewing and Modifying Existing Content

You need to update an existing instruction set:

  1. You open the Markdown Editor page, and your existing instructions appear in the text area.
  2. You notice a typo and use the search icon (magnifying glass) to find the word.
  3. You type the incorrect word into the search bar, and the editor highlights all occurrences.
  4. You use the arrow buttons next to the search bar to jump to each instance and correct them.
  5. After making your changes, the system will automatically save your changes periodically as long as you are active. You can also manually click "Save" to ensure the latest version is stored immediately.

Scenario 3: Using the Preview Mode for Final Check

Before sharing your document, you want a clean view of the final output:

  1. You have finished editing your document in "Editor" or "Split" mode.
  2. You click the "Preview" button in the top right.
  3. The screen now displays only the formatted version of your Markdown content, without any editing tools.
  4. You read through the preview to catch any final formatting issues or errors.
  5. To make further edits, simply click the "Editor" or "Split" button again.

Possible errors which may occur on this page

Error: Your Session Has Expired

This error occurs if you leave the Markdown editor open without any activity for an extended period, or if your session has otherwise ended due to security reasons. When this happens:

  • You will see a notification informing you that your session has expired.
  • The editor page will automatically close to protect your data.
  • Why it happens: This is a security measure to ensure unauthorized access to your work is prevented if you step away from your computer.
  • How to prevent it: Make sure to save your work regularly and close the editor if you plan to be away for a long time. The system will warn you beforehand if your session is about to expire, giving you a chance to react.

Error: Failed to Save Your Work

Sometimes, when you click the "Save" button, you might see an error message (e.g., "Error saving project: Network Error").

  • Why it happens: This usually indicates a temporary problem with your internet connection or a brief issue with the server.
  • How to handle it:
    1. Check your internet connection.
    2. Wait a moment and try clicking the "Save" button again.
    3. If the problem persists, you may need to copy your recent changes manually (highlighting the text and pressing Ctrl+C or Cmd+C) and refresh the page, then paste your content back in after logging in again if necessary.

Up to User Manual Main Page