Manual Editor

User Manual

1.0

Menu configuration may vary or some features may not be supported depending on the product version.

01

Getting Started with Manual Editor

Manual Editor is a tool for editing YAML-based manual content and syncing it to Sanity CMS.

Accessing Manual Editor

Learn how to access the Manual Editor.

  1. Open Manual Editor URL in browser
    Development: http://localhost:3010/admin/manual-editor Production: https://your-domain.com/admin/manual-editor
  2. Select Product
    Select the manual product to edit from the product dropdown in the header.
  3. Select Section
    Click on the section file to edit from the left sidebar.

Editor Modes (YAML / Form)

Manual Editor provides two editing modes.

YAML Mode
YAML Mode edits the original YAML file directly.
  • View entire file structure at a glance
  • Good for quick bulk edits
  • Suitable for users familiar with YAML syntax
  • _product.yaml files can only be edited in YAML mode
Form Mode
Form Mode edits using a visual form interface.
  • Edit with intuitive UI
  • Reorder with drag and drop
  • Built-in image picker
  • Real-time preview
  • Only supports section files (excludes _product.yaml)

Auto-Save Feature

Manual Editor provides auto-save functionality.

Auto-Save Behavior
  • Auto-save after 2 seconds: After editing, if there's no input for 2 seconds, the file is automatically saved.
  • Immediate save on section switch: When switching to another section, changes to the current section are saved immediately.
  • Save status display: You can check undeployed sections with the yellow dot (🟡) in the sidebar.
02

Editing Content

Learn how to edit sections, subsections, and content in Form mode — including Document Info and auto subsection TOC.

Adding a New Section

Learn how to create a new section file.

  1. Click the + button
    Click the "+" button at the top of the sidebar.
  2. Enter Section Information
    Enter the following information in the modal:
    • Order: Numbers only (e.g., "3" → number becomes 03 automatically)
    • Document Info (unnumbered): Check for release notes, legal notices, etc.
    • Slug: Lowercase letters, numbers, and hyphens only (e.g., "new-feature")
    • Title: Enter multilingual title
  3. Creation Complete
    Click the ✅ button to create the new section file, which will be automatically selected.

Adding a Subsection

Learn how to add a subsection within a section.

  1. Click the + Add Subsection button
    In Form mode, click the "+ Add Subsection" button.
  2. Enter Subsection Information
    Enter the following information for the subsection:
    • ID: Unique identifier (e.g., "feature-overview")
    • Title: Multilingual title
    • Description: Multilingual description (optional)

Adding Content

Learn how to add Step Guide, InfoBox, Screenshot, and Table to subsections.

Content Types
Manual Editor supports the following 4 content types: 1. Step Guide: Step-by-step guide (can include images) 2. InfoBox: Information box (info, warning, tip, danger) 3. Screenshot: Screenshot image 4. Table: Table (manualTable)
  1. Expand Subsection
    Click on the subsection to expand it where you want to add content.
  2. Select Content Type
    Click the "+ Add Content" button and select the desired content type.
  3. Edit Content
    Enter the fields according to the selected content type.

Reordering with Drag and Drop

You can reorder subsections and content by dragging and dropping.

  1. Drag Item
    Click and drag the subsection or content item you want to move.
  2. Drop at Target Location
    Drag to the desired location and release the mouse to change the order.

Document Information Area

Use the Document Information area for release notes, legal notices, and open-source licenses. It appears below the Table of Contents on the product cover, without section numbers.

  1. Open a section file (not _product.yaml)
    Document Info is not configured in _product.yaml. Create or open a section YAML file (e.g., 90-release-notes.yaml, 08-reference.yaml).
  2. Enable Document Info (unnumbered)
    In Form mode, open Section Info and check Document Info (unnumbered). Or in YAML mode, set: ``yaml section: number: "" slug: release-notes order: 90 unnumbered: true title: ko: 릴리즈 노트 en: Release Notes ``
  3. Check the product cover preview
    After save and Sanity sync, the section appears under Document Information on the product cover (below Contents), without a number badge. Numbered chapters stay under Contents; unnumbered sections move to Document Information.
Tips
  • Select _product.yaml in the sidebar to preview the cover (Contents + Document Information).
  • Existing sections like "Reference / Legal Notice" can be moved by enabling Document Info (unnumbered) on that section file.
  • Order still controls sort order; only the number display is hidden.

Auto Subsection Table of Contents

When a section has 3 or more subsections, a title-link TOC is generated automatically at the top of the section page.

How it works
Behavior
  • Shown only when there are 3 or more subsections
  • Lists subsection titles as in-page links
  • Clicking a link scrolls to that subsection (#id)
  • No manual TOC editing required — titles come from each subsection
Editor tip: Fill in each subsection ID (e.g., feature-overview). The ID is used as the anchor for the link.
Note
With fewer than 3 subsections, the TOC is hidden so short sections stay uncluttered.
03

Image Upload and Deployment

Learn how to upload images and deploy changes to the server.

Uploading Images

Learn how to upload images to Manual Editor.

  1. Open Image Picker
    In Form mode, click the "📷 Select Image" button next to the image field.
  2. Upload Image
    In the image picker modal: 1. Click the "📤 Upload" button 2. Select the image file to upload 3. After upload completes, select from the image list
  3. Set Multilingual Images
    In the image picker, select language tabs (🇰🇷 Korean, 🇺🇸 English, 🇯🇵 Japanese, 🇪🇸 Spanish) to set different images for each language.

Checking Sync Status

Learn how to check the synchronization status between YAML files and Sanity CMS.

Sync Status Icon
You can check the current status with the sync status icon in the header:
  • Synced: YAML and Sanity match
  • ⚠️ Has Differences: Some fields differ
  • Not Deployed: Document not in Sanity
  • 🔄 Checking: Checking status
Sidebar Indicator
In the sidebar section list:
  • Yellow dot (🟡): Section not deployed to server
  • None: Section deployed to server
Sections with yellow dots need to be deployed by clicking the "Server Deployment" button.

Deploying to Server

Learn how to sync changes to Sanity CMS and deploy to the server.

  1. Check Changes
    Verify that your edits have been auto-saved. (Auto-saved after 2 seconds or when switching sections)
  2. Click Server Deployment Button
    Click the "🚀 Server Deployment" button in the header.
    • A full-screen loading overlay will appear
    • Synchronization to Sanity CMS will proceed
    • Results will be shown in a toast message when complete
  3. Git Commit (Optional)
    Click the "▼" button next to "🚀 Server Deployment" to select "Deploy + Commit". To perform Git Commit: 1. Enter Git username and email 2. Enter commit message 3. Click "🚀 Deploy + Commit" button
Important Notes
  • Server deployment is performed only for the currently open section.
  • Git Commit also includes only the current section file and all images for that product.
  • It is recommended to check the sync status before deployment to ensure there are no differences.
04

Tips and Advanced Features

Learn tips and advanced features to use Manual Editor more efficiently.

Keyboard Shortcuts

Learn keyboard shortcuts available in Manual Editor.

단축키기능설명
Ctrl + S저장현재 파일 저장 (자동 저장과 동일)
Ctrl + Z실행 취소YAML 모드에서만 사용 가능
Ctrl + Y다시 실행YAML 모드에서만 사용 가능
Ctrl + F찾기YAML 모드에서 텍스트 검색

Using Markdown Formatting

You can use Markdown syntax in text fields to apply formatting.

Supported Markdown Syntax
  • Bold: **text**
  • Italic: *text*
  • Code: ` code `
  • Strikethrough: ~~text~~
  • Link: [text](https://...)
  • Keyboard: {{kbd:Ctrl+S}}
  • Icon: {{icon:house}}

Deleting Content

Learn how to delete sections, subsections, and content.

Delete Confirmation
All delete operations show a confirmation modal.
  • Delete Section: 🗑️ button in sidebar
  • Delete Subsection: 🗑️ button in subsection header
  • Delete Content: 🗑️ button in content item
  • Delete Step: 🗑️ button in Step Guide step
Deletion cannot be undone, so be careful.

Best Practices

Learn best practices for using Manual Editor efficiently.

Recommendations
1. Edit in small units: Don't make too many changes at once, edit section by section. 2. Use auto-save: Auto-saves after 2 seconds, so you don't need to press save. 3. Check preview: Use the right-side preview in Form mode to check results in real-time. 4. Check sync status: Before deployment, check the sync status icon to ensure there are no differences. 5. Optimize images: Optimize images to appropriate size before uploading. 6. Multilingual input: ko and en are required, so be sure to enter them. 7. Separate Document Info: Put release notes, legal notices, and open-source licenses in Document Info (unnumbered) sections — not in _product.yaml. 8. Subsection IDs: With 3+ subsections, an auto TOC appears at the top — give each subsection a meaningful ID for anchor links.