Skip to content

Commit f42f9fc

Browse files
committed
Improved documentation
1 parent 0b89329 commit f42f9fc

File tree

2 files changed

+8
-6
lines changed

2 files changed

+8
-6
lines changed

docs/glossary/glossary.mdx

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ The structure of an LF project should follow the directory layout below:
3030

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

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

5051
- **Automatically Generated Directories:**
51-
- `bin/`: This directory is created during the build process of source files. It is used to store generated code.
52-
- `build/`: This folder is automatically generated when installing packages managed by the Lingo Package Manager.
53-
- `include/`: This directory is autogenerated for header files.
54-
52+
- `bin/`: Created during the build process to store binary executables.
53+
- `build/`: Generated automatically when installing packages managed by the Lingo Package Manager.
54+
- `include/`: Autogenerated to store header files.
55+
- `src-gen/` (or `fed-gen` for federated programs): Autogenerated to store generated code.
56+
5557
- **User-Created Directory:**
5658
- `src/lib/`: This folder is for library files and should be created by the user as necessary.
5759

docs/tools/code-extension.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ The image below shows a visual representation of the **Installed Packages** sect
120120

121121
The hierarchy categorizes tree items into the following types:
122122

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

0 commit comments

Comments
 (0)