Skip to content

Commit 1bb11e5

Browse files
(docs) Add core structure
1 parent 2c2ff56 commit 1bb11e5

18 files changed

Lines changed: 249 additions & 89 deletions

File tree

docs/docs/content/CHANGELOG.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# :material-newspaper: Changelog
2+
3+
All notable changes to RayforceDB VS Code Extension will be documented in this file.
4+
5+
!!! note ""
6+
You can also subscribe for release notifications by joining our [:simple-zulip: Zulip](https://rayforcedb.zulipchat.com/#narrow/channel/549008-Discuss)!
7+
8+
9+
## **`0.4.0`**
10+
11+
- Added full Rayfall language support with syntax highlighting and autocomplete
12+
- Improved REPL integration with environment variable inspection
13+
- Enhanced instance manager with folder organization for saved instances
14+
- Added custom file icons for `.rfl` and `.rf` files
15+
16+
2025-01-XX | **[🔗 VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=RayforceDB.rayforce-vscode)** | **[🔗 GitHub](https://github.com/RayforceDB/rayforce-vscode/releases/tag/0.4.0)**
17+

docs/docs/content/documentation/overview.md

Lines changed: 0 additions & 4 deletions
This file was deleted.

docs/docs/content/documentation/syntax/overview.md

Lines changed: 0 additions & 4 deletions
This file was deleted.

docs/docs/content/documentation/usage/instances.md

Lines changed: 0 additions & 4 deletions
This file was deleted.

docs/docs/content/documentation/usage/monitoring.md

Lines changed: 0 additions & 4 deletions
This file was deleted.

docs/docs/content/documentation/usage/overview.md

Lines changed: 0 additions & 4 deletions
This file was deleted.

docs/docs/content/documentation/usage/repl.md

Lines changed: 0 additions & 4 deletions
This file was deleted.
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Appearance
2+
3+
The RayforceDB VS Code Extension provides visual enhancements to make working with Rayfall code more enjoyable and efficient.
4+
5+
## Custom File Icons
6+
7+
Custom icons are provided for Rayfall source files to help you easily identify them in your project:
8+
9+
- `.rfl` files - Rayfall source files
10+
- `.rf` files - Rayfall source files
11+
12+
These icons appear in the VS Code file explorer, making it quick to spot Rayfall files in your project structure.
13+
14+
IMAGE HERE
15+
16+
## Syntax Highlighting
17+
18+
Full syntax highlighting support for the Rayfall programming language, including:
19+
20+
- **Keywords**: Special forms like `fn`, `let`, `if`, `do`, etc.
21+
- **Functions**: Built-in functions with proper highlighting
22+
- **Types**: Type names and type casts
23+
- **Strings**: String literals with escape sequence support
24+
- **Numbers**: Integers, floats, and special numeric literals
25+
- **Symbols**: Keyword symbols and quoted symbols
26+
- **Comments**: Line comments starting with `;`
27+
28+
IMAGE HERE
29+
30+
The syntax highlighting makes your Rayfall code more readable and helps catch syntax errors at a glance.
31+
Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Instance Manager
2+
3+
The Instance Manager provides a comprehensive view of all your RayforceDB instances, both local and remote.
4+
5+
## Local Instances
6+
7+
The extension automatically detects running local RayforceDB instances on your machine. You can see:
8+
9+
- Process ID (PID)
10+
- Port number
11+
- Connection status
12+
- Process information (CPU and memory usage)
13+
14+
IMAGE HERE
15+
16+
## Saved Instances
17+
18+
Save frequently used remote instances for quick access. Saved instances are persistent, so you don't need to set them up every time you open VS Code.
19+
20+
IMAGE HERE
21+
22+
## Folder Organization
23+
24+
Organize your saved instances into handy folders and subfolders:
25+
26+
- Create folders to group related instances
27+
- Create subfolders for even better organization
28+
- Drag and drop instances between folders
29+
- Rename or delete folders as needed
30+
31+
IMAGE HERE
32+
33+
## Connection Management
34+
35+
- **Connect**: Click the connect button to establish a connection to an instance
36+
- **Disconnect**: Disconnect from the current instance when done
37+
- **Refresh**: Refresh the list to see newly started instances
38+
39+
IMAGE HERE
40+
41+
## Process Monitoring
42+
43+
For local instances, view real-time process information including:
44+
45+
- CPU usage
46+
- Memory consumption
47+
- Process details
48+
49+
This helps you monitor resource usage and optimize your RayforceDB instances.
50+
51+
IMAGE HERE
52+
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Overview
2+
3+
The RayforceDB VS Code Extension provides a complete development environment for RayforceDB, right inside VS Code.
4+
5+
## Features
6+
7+
### **Instance Manager**
8+
9+
View and connect to running local and remote RayforceDB instances. Organize saved connections into folders and subfolders for easy management.
10+
11+
### **Interactive REPL**
12+
13+
Fully integrated REPL panel for executing Rayfall commands. Access environment variables, get autocomplete suggestions, and interact with your RayforceDB instances seamlessly.
14+
15+
### **Environment Inspector**
16+
17+
Introspect environment variables and see what's defined in your connected RayforceDB instance. Monitor process information and system resources.
18+
19+
### **Rayfall Language Support**
20+
21+
Full language support for the Rayfall programming language:
22+
23+
- **Syntax Highlighting**: Beautiful syntax highlighting for `.rfl` and `.rf` files
24+
- **Autocomplete**: Intelligent autocomplete with built-in functions, keywords, and types
25+
- **File Icons**: Custom icons for Rayfall source files
26+

0 commit comments

Comments
 (0)