> For the complete documentation index, see [llms.txt](https://frostember-studios.gitbook.io/frostnote/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://frostember-studios.gitbook.io/frostnote/documentation.md).

# Documentation

## FrostNote

FrostNote is an editor-only Unity 6 documentation tool for keeping project notes, task notes, references, and team documentation inside the Unity Editor.

### Installation

1. Install FrostNote through Unity Package Manager or embed `com.frostemberstudios.frostnote` under the project's `Packages` folder.
2. Open `Tools/Frostember Studios/FrostNote`.
3. Create a shared notebook for team documentation or use a private notebook for local notes.

### Team Workflow

* FrostNote code and UI assets are installed as a UPM package under `Packages/com.frostemberstudios.frostnote`.
* FrostNote is standalone and does not require other Frostember packages.
* Shared notebooks are stored under `Assets/FrostemberStudios/FrostNoteData` and should be versioned in Git or Plastic SCM.
* Private notebooks and user preferences are stored under the project `UserSettings/FrostNote` folder.
* `UserSettings` should stay ignored in version control. The included Plastic ignore pattern already ignores it; Git projects should add `UserSettings/` to `.gitignore`.
* Existing shared notebooks from the legacy `Assets/FrostemberStudios/FrostNote/Editor/Data` location are copied to the UPM-safe shared data folder on first load.
* The package folder is code/assets only. User-created notes are intentionally kept outside the package so updating or replacing the package does not delete shared or private notebooks.

### Main Features

* Page tree with subpages, favorites, rename, duplicate, delete, and drag/drop ordering.
* Rich editor blocks: headings, paragraphs, bullet lists, numbered lists, checkboxes, toggles, code blocks, quotes, callouts, dividers, tables, images, page links, and columns.
* Inline formatting: bold, italic, underline, strikethrough, code, links, and comments.
* Slash commands, Insert panel, command palette, markdown import/export, comments panel, and settings.
* Hybrid storage for shared team docs and local private notebooks.

### Data Safety Notes

* Deleting a parent page keeps direct subpages by moving them one level up.
* Page/block data is validated on load/save to repair missing IDs, null lists, invalid block types, broken page parent references, and accidental cycles.
* Notebook, page, and attachment file paths are sanitized so saved data stays inside the shared or private FrostNote storage roots.
* Attachment imports are written with generated safe filenames; Unity asset references continue to resolve through Unity GUIDs.
* The settings panel includes an Open Data Folder action for checking the active shared/private storage location.
* Back up shared notebook data before large migrations or source-control merges.

### Known Limitations

* FrostNote is an editor extension only and does not add runtime components to builds.
* FrostNote targets Unity 6.0 or newer.
* Real-time collaborative editing is not included; use Git or Plastic merge/review workflows for shared notebook files.
* Markdown export covers FrostNote content as best-effort Markdown. Advanced blocks such as columns and toggles are exported to readable Markdown/HTML-compatible text.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://frostember-studios.gitbook.io/frostnote/documentation.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.