Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
b45b77b
Updated VSCode extention docs
vinzbarbuto Oct 15, 2024
8106587
Update documentation to reflect latest changes
vinzbarbuto Oct 16, 2024
1be6372
Remove unnecessary ‘shell’ usage
vinzbarbuto Oct 17, 2024
b3c04e0
Update docs/tools/code-extension.mdx
vinzbarbuto Oct 21, 2024
d212ef3
Update docs/tools/code-extension.mdx
vinzbarbuto Oct 21, 2024
e057239
Update docs/tools/code-extension.mdx
vinzbarbuto Oct 21, 2024
ff2b7c8
Update docs/tools/code-extension.mdx
vinzbarbuto Oct 21, 2024
7426658
Update documentation; PNGs instead of SVGs
vinzbarbuto Oct 21, 2024
203e8b3
Update documentation; PNGs instead of SVGs
vinzbarbuto Oct 21, 2024
cda2817
Merge branch 'main' into main
vinzbarbuto Oct 21, 2024
3c69580
Added 'Create New Project' section; uniformed the use of 'package' in…
vinzbarbuto Oct 22, 2024
664bef0
Added 'Create New Project' section; uniformed the use of 'package' in…
vinzbarbuto Oct 22, 2024
7036389
Improved documentation
vinzbarbuto Oct 23, 2024
f6f1662
Improved paths in the documentation
vinzbarbuto Oct 23, 2024
5b63b67
Apply suggestions from code review
vinzbarbuto Oct 28, 2024
ed2eb08
Improved documentation; Added Glossary page
vinzbarbuto Oct 28, 2024
6fa21f1
Apply suggestions from code review
vinzbarbuto Oct 28, 2024
942770b
Update docs/tools/code-extension.mdx
vinzbarbuto Oct 28, 2024
0b89329
Improved documentation; Moved Project Structure to Glossary page
vinzbarbuto Oct 29, 2024
f42f9fc
Improved documentation
vinzbarbuto Oct 29, 2024
e544f53
Update docs/glossary/glossary.mdx
vinzbarbuto Oct 29, 2024
d4ccc94
Update code-extension.mdx
lhstrh Oct 29, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions docs/glossary/glossary.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ The structure of an LF project should follow the directory layout below:

```
├── .
│ ├── bin/ # Directory for storing generated code
│ ├── bin/ # Directory for storing binary executables
│ ├── build/ # Directory containing packages installed by the Lingo Package Manager
│ │ ├── lfc_include/ # Directory for storing reusable reactors
│ │ └── <Installed Package>/ # Directory containing the installed package
Expand All @@ -40,6 +40,7 @@ The structure of an LF project should follow the directory layout below:
│ │ │ ├── Input.lf # Ex: reactor capturing external inputs (e.g., Microphone, Camera)
│ │ │ └── ComputerVision.lf # Ex: reactor performing computer vision tasks (e.g., object detection, face recognition)
│ │ └── Main.lf # Ex: main source file
│ ├── src-gen/ # Directory for storing generated code (or fed-gen if a federated program)
└── └── Lingo.toml # Configuration file for Lingo Package Manager
```

Expand All @@ -48,10 +49,11 @@ The structure of an LF project should follow the directory layout below:
- `Lingo.toml`: This is the required configuration file.

- **Automatically Generated Directories:**
- `bin/`: This directory is created during the build process of source files. It is used to store generated code.
- `build/`: This folder is automatically generated when installing packages managed by the Lingo Package Manager.
- `include/`: This directory is autogenerated for header files.

- `bin/`: Created during the build process to store binary executables.
- `build/`: Generated automatically when installing packages managed by the Lingo Package Manager.
- `include/`: Autogenerated to store header files.
- `src-gen/` (or `fed-gen` for federated programs): Autogenerated to store generated code.

- **User-Created Directory:**
- `src/lib/`: This folder is for library files and should be created by the user as necessary.

Expand Down
2 changes: 1 addition & 1 deletion docs/tools/code-extension.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ The image below shows a visual representation of the **Installed Packages** sect

The hierarchy categorizes tree items into the following types:

1. **package-root**: Refers to the root folder of each downloaded package.
1. **package root**: Refers to the root folder of each downloaded package.
2. **file**: Represents an LF file within the package.
3. **reactor**: Refers to individual reactors within the LF file.

Expand Down
Loading