# Editor_Sync

**Repository Path**: zhaohaoran09/editor_-sync

## Basic Information

- **Project Name**: Editor_Sync
- **Description**: ArkGraphicEditor
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-09-03
- **Last Updated**: 2026-09-04

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README


Internal documentation is authored in the [documentation](documentation) folder. This includes build instructions,
debugging tips,
file format specifications, design documents, etc.

- **Development Guide**
    - [Building the Editor](documentation/Building%20the%20Editor.md)
    - [Updating to the VS2022 Toolchain](documentation/Updating%20to%20the%20VS2022%20Toolchain.md)
    - [Developer Tips](documentation/Developer%20Tips.md)
    - [Crashdump Debugging](documentation/Crashdump%20Debugging.md)
    - [Code Formatting](documentation/Code%20Formatting.md)
    - [Running UI tests locally](.ci/README.md)
- **Workflows**
    - [Internationalization (Translation) Workflow](documentation/Internationalization%20(Translation)%20Workflow.md)
    - [Releasing](documentation/Releasing.md)
    - [How to update the Advanced Docking System (ADS)](documentation/How%20to%20update%20the%20Advanced%20Docking%20System%20(ADS).md)
- **Coding Practices & Lessons**
    - [Assertions & Bugs](documentation/Assertions%20&%20Bugs.md)
    - [Benefits of the optional type](documentation/Benefits%20of%20the%20optional%20type.md)

- **Design Documents**
    - [Property Editors](documentation/Property-Editing.md)
    - [Shader Graph Docs](documentation/Shader%20Graph.md)
    - [Design and architecture of window management, actions and events](documentation/Design%20and%20architecture%20of%20window%20management,%20actions%20and%20events.md)
    - [Safe Composite Command and Undo-Redo Semantics](documentation/Safe%20Composite%20Command%20and%20Undo-Redo%20Semantics.md)
    - [Package and Plugin File Format](documentation/Package%20and%20Plugin%20File%20Format.md)
- **Possibly obsolete old docs:**
    - [Extension API Drafting](documentation/Extension%20API%20Drafting.md)
    - [HMI Toolkit Integration](documentation/HMI%20Toolkit%20Integration.md)
    - [Editor API](documentation/Editor%20API.md)

## How to edit the docs

## Obsidian

Obsidian is a powerful Markdown knowledge management IDE, much like VSCode but for notes. It allows extreme
customization with shortcuts for actions, beautiful themes (e.g. Tokyo Night), a graph view for inspecting the links
between notes, and automatic link updates when we rename or move a file. **It is encouraged to use Obsidian to maintain
consistency.**

### Initial Setup

- E.g. on windows: `winget install -e --id Obsidian.Obsidian`
- Open the `/documentation` folder in obsidian as your vault. (Not the whole folder, that blows up the indexing)
- Set up keyboard shortcuts. (See settings via `Ctrl+,`)
    - Recommended actions to set up:
        - Navigate back/forth -> `Alt+Left` / `Alt+Right`
        - Reorder lines/paragraphs -> `Alt+Up` / `Alt+Down`
        - Command palette -> `F1`
        - Quick switcher (search for files) -> `Ctrl+P`
    - Other useful shortcuts that are available by default:
        - Close current tab: `Ctrl+W`
        - Reopen last closed tab: `Ctrl+Shift+T`

### Note Organization

- Don't worry too much about note organization with folders. Notes are usually not hierarchical but form an intricate
  graph of connections (links between pages). This graph can always be explored via Obsidian.
  ![](attachments/Pasted%20image%2020250506115310.png)
  ![](attachments/Pasted%20image%2020250506115230.png)
- For simplicity, we configured the obsidian project to put all attachments into one folder in
  `documentation/attachments`. If you want to see which attachments are used by which notes, you can use the graph view
  and toggle displaying attachments.
- You can use the [dataview](https://github.com/blacksmithgu/obsidian-dataview) extension to run interesting queries.
- You can rename files if really needed, references are updated automatically inside the `documentation/` folder.
  However, there are some references in this readme file, so check for references with a project-wise code search when
  renaming.