diff --git a/docs/lync/project-format/files/meta-files.md b/docs/lync/project-format/files/meta-files.md index cc745f8..f7dd6f0 100644 --- a/docs/lync/project-format/files/meta-files.md +++ b/docs/lync/project-format/files/meta-files.md @@ -4,14 +4,14 @@ Meta Files attach additional data to a file or directory. They are used in scenarios where it would be desirable to change the properties of something which otherwise cannot be changed from the filesystem. ## Syntax - -### File Name +::: info File Name - `*.Meta.JSON` - For files. - `Init.Meta.JSON` - For directories. - -### Keys +::: +::: info Keys - string `className` - Changes the ClassName. Usable only with directories. - table `properties` - A map of properties to set on the Instance. +::: ## Examples The most common use case is changing the ClassName of a Folder. diff --git a/docs/lync/project-format/sourcemap.md b/docs/lync/project-format/sourcemap.md index d676926..c4d8feb 100644 --- a/docs/lync/project-format/sourcemap.md +++ b/docs/lync/project-format/sourcemap.md @@ -1,6 +1,32 @@ -::: danger UNFINISHED -This documentation is unfinished. -::: # Sourcemap +The Sourcemap is an automatically generated file that serves as a layout of the project for other tools to utilize. + +This file cannot be deleted and should be ignored unless you're a tool developer. ## Syntax +::: info Keys +- string `name` - Instance.Name. +- string `className` - Instance.ClassName. +- {string} `filePaths` - The list of files that have an effect on the Instance. +- {Instance} `children` - The list of children. +::: + +## Example + +```json +{ + "name": "Example Place", + "className": "DataModel", + "filePaths": [ + "default.project.json" + ], + "children": [ + { + "name": "Workspace", + "className": "Workspace", + "children": [] + } + ], + ... +} +``` \ No newline at end of file