Skip to content

Commit

Permalink
final changes
Browse files Browse the repository at this point in the history
  • Loading branch information
2jammers committed May 12, 2024
1 parent e511f48 commit 3b90d5b
Show file tree
Hide file tree
Showing 6 changed files with 63 additions and 19 deletions.
5 changes: 2 additions & 3 deletions docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ export default defineConfig({
text: 'Guides',
items: [
{ text: 'Setup', link: '/guides/' },
{ text: 'Conventions', link: '/guides/conventions' },
{ text: 'Signals', link: '/guides/signals' },
{ text: 'Networking', link: '/guides/networking' },
{ text: 'Networking Expanded', link: '/guides/networkingexpanded' }
Expand All @@ -43,6 +42,7 @@ export default defineConfig({
text: 'API Reference',
items: [
{ text: 'Framework', link: '/api/' },
{ text: 'Network', link: '/api/network/'},

{
text: 'Interfaces',
Expand All @@ -54,10 +54,9 @@ export default defineConfig({
},

{
text: 'Network',
text: 'Network Interfaces',
collapsed: true,
items: [
{ text: 'Network', link: '/api/network/'},
{ text: 'ClientEvent', link: '/api/network/client/event' },
{ text: 'ServerEvent', link: '/api/network/server/event' },
{ text: 'ClientFunction', link: '/api/network/client/function' },
Expand Down
51 changes: 50 additions & 1 deletion docs/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,40 @@

This is the changelog which is changed every update, and we follow semver.

## 8.0.0-rc1
## 8.0.0

---

### Added

* Adds reviews to docs home page

### Improvements

* Nothing

### Removed

* Nothing

## 8.0.0-rc2

---

### Added

* Nothing

### Improvements

* Improve main module structure
* Fix typing bug with `.Load()`

### Removed

* Nothing

## 8.0.2-rc1

---

Expand All @@ -12,8 +45,24 @@ This is the changelog which is changed every update, and we follow semver.

### Improvements

* Fixes yielding bug on client when character does not load

### Removed

* Nothing

## 8.0.1-rc1

---

### Added

* Nothing

### Improvements

* Fix networking interface issues

### Removed

* Nothing
Expand Down
3 changes: 0 additions & 3 deletions docs/guides/conventions.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/guides/signals.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Signals
# Signals

Signals are an object that allows you to communicate across scripts easily. Think bindable events but in a much more optimized Luau form. These signal objects are automatically garbage collected and have a few more utility functions that come with. You can create a signal by running the `Framework.Signal` function. Leave the name blank to create a signal that has no reference in the framework and can only be used locally.

Expand Down
17 changes: 8 additions & 9 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,13 @@ hero:
link: /api/

features:
- icon: 🎒
title: Lightweight
details: No extra bloatware attached, only what it needs to function
- icon:
title: Lightning Fast
details: A framework that only does what you want it to; no extra side effects
- icon: 🔐
title: Secure
details: Fast and efficient networking system designed to block exploiters
- icon:
src: https://avatars.githubusercontent.com/u/118916772?v=4
title: AridAjd
details: <i>'Using the framework, you literally have no worries. The internal is heavily type-checked and also gives you the ability to keep your code to be strict on types. No bloat, lightweight on performance, straightforward API and does proper implementation of promises to improve development experience. Overall, a solid framework!'</i>
- icon:
src: https://avatars.githubusercontent.com/u/110689336?v=4
title: GameboyTheDev
details: <i>'Lumin Framework is the best I have seen so far in making networking as simple and straightforward as possible! Would recommend!'</i>
---

4 changes: 2 additions & 2 deletions wally.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[package]
name = "lumin/framework"
description = "A lightning fast & lightweight game framework for Roblox"
version = "8.0.0-rc3"
description = "A lightning fast & amazing game framework for Roblox"
version = "8.0.0"
license = "MIT"
registry = "https://github.com/UpliftGames/wally-index"
realm = "shared"
Expand Down

0 comments on commit 3b90d5b

Please sign in to comment.