Update overview.md to match the current codebase#148
Open
Suylang wants to merge 7 commits into
Open
Conversation
…nd correcting responsibilities
… outdated entries, and ensure ordering consistency.
cameronhum
reviewed
May 8, 2026
| ## Purpose | ||
|
|
||
| Explains how each JavaScript file fits into the IDE startup, loading, and runtime process. Shows how the pieces interact to build the editor and initialize the environment. This documentation aims to explain the softwares architecture so that it can be understood better making the system easier to navigate, extend, and debug | ||
| Explains how each JavaScript file fits into the IDE startup, loading, and runtime process. Shows how the pieces interact to build the editor and initialize the environment. This documentation explains the software architecture of the IDE, helping developers better understand how the system works. This makes it easier to navigate, extend, and debug. |
Contributor
There was a problem hiding this comment.
Very necessary, good addition
| | `actionQueue.js` | Action sequencing engine | Manages async task execution, ordering, cancellation, and dependency in the form of a queue | | ||
| | `IDEStartupMain.js` | IDE bootstrap coordinator | Central script that initializes components and kicks off IDE startup sequence | | ||
| | `themes.js` | Theme manager | Defines and applies color themes by modifying CSS variables; updates UI via dropdown | | ||
| --- |
Contributor
There was a problem hiding this comment.
the new tables are inconsistent with spacing. are we able to make sure they are consistent like the old one so it is a bit easier to read
| | `themes.js` | Theme manager | Defines and applies color themes by modifying CSS variables; updates UI via dropdown | | ||
| --- | ||
|
|
||
| ## Server Layer |
Contributor
There was a problem hiding this comment.
make titles smaller so that they aren't same as Files Overview title
| --- | ||
| ## Loading & Initialization Flow | ||
|
|
||
| --- |
Contributor
There was a problem hiding this comment.
you have --- on both sides of the title here. but don't everywhere. I would remove since it doubles up with this underline
| | `actionQueue.js` | Action sequencing engine | Manages async task execution, ordering, cancellation, and dependency in the form of a queue | | ||
| | `IDEStartupMain.js` | IDE bootstrap coordinator | Central script that initializes components and kicks off IDE startup sequence | | ||
| | `themes.js` | Theme manager | Defines and applies color themes by modifying CSS variables; updates UI via dropdown | | ||
| --- |
Contributor
There was a problem hiding this comment.
you have --- on both sides of the title here. but don't everywhere. I would remove since it doubles up with this underline
| ↳ setup.js | ||
| ↳ node_modules (dependency ecosystem injected at runtime via npm install) | ||
| ↳ Node.js module resolution system | ||
| ↳ injects dependencies using require() at runtime |
Contributor
There was a problem hiding this comment.
these spacings are broken in markdown. theres a few spots with this. use the technique to add them in
| ↳ resolves Express, middleware, build tools, and setup utilities | ||
|
|
||
| ↳ Static folder injection | ||
| ↳ assets/ (images, icons, UI resources) |
Contributor
There was a problem hiding this comment.
I don't see this injected in the server. Remove?
| - Queues like `IDECoreInitQueue`, `CompilerInitQueue`, `ExecutionEnvironmentLoadQueue`, and others run in order or in parallel. | ||
| - Handles initialization of the UI, compiler, project storage, and sandbox. | ||
| - Defines `StartIDE()` as the main startup entrypoint. | ||
| ### layout.js |
Contributor
There was a problem hiding this comment.
where is this called in the flow/initialization?
| - Allows for (`waitOn`), cancellations (`cancelOn`), and ('synchronousWith'). | ||
| - Includes test utilities and full control over task execution flow via `Schedule()` and `Consume()`. | ||
|
|
||
| ### communication.js |
Contributor
There was a problem hiding this comment.
wheres this in the initialization flow
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Overview.md's IDE architectural description has been updated to reflect the current codebase structure and accurate file responsibilities. The documentation is now more accurate and clear, making it easier for developers to comprehend the system modules, execution environment, and startup procedure. There weren't any modifications made to the functional code.
Fixes # (issue)
Type of change
expected)
How Has This Been Tested?
Manually reviewed updated documentation against the current project file structure and verified correctness by cross-checking with the codebase.
Testing Checklist
Checklist