Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Snippet Documentation #32

Open
1 task done
DanCodesRBX opened this issue Dec 3, 2024 · 0 comments
Open
1 task done

Snippet Documentation #32

DanCodesRBX opened this issue Dec 3, 2024 · 0 comments
Assignees
Labels
enhancement New feature or request ready to work on Related changes are ready to be made targeting: docs Targets the documentation

Comments

@DanCodesRBX
Copy link

DanCodesRBX commented Dec 3, 2024

Original

  • My issue is original

Description

Add predefined Visual Studio Code snippets to the documentation for Controllers and Starting the framework. Ex: https://sleitnick.github.io/Knit/docs/vscodesnippets

Here are some example snippets I made for the framework:

"Framework Controller": {
    "prefix": [
        "FrameworkController"
    ],
    "body": [
        "local ReplicatedStorage = game:GetService(\"ReplicatedStorage\")",
        "",
        "local Framework = require(ReplicatedStorage.Packages.Framework)",
        "",
        "local function Init()",
        "\t",
        "end",
        "",
        "local function Start()",
        "\t",
        "end",
        "",
        "return Framework.New({",
        "\tInit = Init,",
        "\tStart = Start,",
        "})",
        ""
    ],
    "description": "Lumin Framework controller template"
},

"Framework Starter": {
    "prefix": [
        "FrameworkStart"
    ],
    "body": [
        "local ReplicatedStorage = game:GetService(\"ReplicatedStorage\")",
        "",
        "local Framework = require(ReplicatedStorage.Packages.Framework)",
        "",
        "local controllers = script.Controllers",
        "",
        "Framework.Start({",
        "\tcontrollers,",
        "})",
        ""
    ],
    "description": "Lumin Framework loader template"
}

Objective

This would help people develop a better workflow whenever starting out with the framework.

@DanCodesRBX DanCodesRBX added enhancement New feature or request not ready - testing This issue is currently being tested to see if it works well ready - closing soon Finished, waiting for next version labels Dec 3, 2024
@jmesrje jmesrje added targeting: docs Targets the documentation and removed ready - closing soon Finished, waiting for next version not ready - testing This issue is currently being tested to see if it works well labels Dec 3, 2024
@jmesrje jmesrje self-assigned this Dec 3, 2024
@jmesrje jmesrje added the ready to work on Related changes are ready to be made label Dec 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request ready to work on Related changes are ready to be made targeting: docs Targets the documentation
Projects
None yet
Development

No branches or pull requests

2 participants