Merge branch 'main' of https://github.com/Ukendio/jecs

.github/ISSUE_TEMPLATE/BUG-REPORT.md

@@ -0,0 +1,22 @@
+---
+name: Bug report
+about: File a bug report for any behavior that you believe is unintentional or problematic
+title: "[BUG]"
+labels: bug
+assignees: ''
+
+---
+
+## Describe the bug
+Put a clear and concise description of what the bug is. This should be short and to the point, not to exceed more than a paragraph. Put the details inside your reproduction steps.
+
+## Reproduction
+Make an easy-to-follow guide on how to reproduce it. Does it happen all the time? Will specific features affect reproduction? All these questions should be answered for a good issue.
+
+This is a good place to put rbxl files or scripts that help explain your reproduction steps.
+
+## Expected Behavior
+What you expect to happen
+
+## Actual Behavior
+What actually happens

.github/ISSUE_TEMPLATE/FEATURE-REQUEST.md

@@ -0,0 +1,27 @@
+---
+name: Feature Request
+about: File a feature request for something you believe should be added to Jecs
+title: "[FEATURE]"
+labels: feature
+assignees: ''
+
+---
+
+## Describe your Feature
+
+You should explain your feature here, and the motivation for why you want it.
+
+## Implementation
+
+Explain how you would implement your feature here. Provide relevant API examples and such here (if applicable).
+
+## Alternatives
+
+What other alternative implementations or otherwise relevant information is important to why you decided to go with this specific implementation?
+
+## Considerations
+
+Some questions that need to be answered include the following:
+- Will old code break in response to this feature?
+- What are the performance impacts with this feature (if any)?
+- How is it useful to include?

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,15 @@
+## Brief Description of your Changes.
+
+Describe what you did here. Additionally, you should link any relevant issues within this section. If there is no corresponding issue, you should include relevant information (repro steps, motivation, etc) here.
+
+## Impact of your Changes
+
+What implications will this have on the project? Will there be altered behavior or performance with this change?
+
+## Tests Performed
+
+What have you done to ensure this change has the least possible impact on the project?
+
+## Additional Comments
+
+Anything else you feel is relevant.

.github/workflows/deploy-docs.yaml

@@ -0,0 +1,64 @@
+# Sample workflow for building and deploying a VitePress site to GitHub Pages
+#
+name: Deploy VitePress site to Pages
+
+on:
+  # Runs on pushes targeting the `main` branch. Change this to `master` if you're
+  # using the `master` branch as the default branch.
+  push:
+    branches: [main]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # Not needed if lastUpdated is not enabled
+      # - uses: pnpm/action-setup@v3 # Uncomment this if you're using pnpm
+      # - uses: oven-sh/setup-bun@v1 # Uncomment this if you're using Bun
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: npm # or pnpm / yarn
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+      - name: Install dependencies
+        run: npm ci # or pnpm install / yarn install / bun install
+      - name: Build with VitePress
+        run: npm run docs:build # or pnpm docs:build / yarn docs:build / bun run docs:build
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/.vitepress/dist
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    needs: build
+    runs-on: ubuntu-latest
+    name: Deploy
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -54,3 +54,11 @@ WallyPatches
 roblox.toml
 sourcemap.json
 drafts/*.lua
+
+# Cached Vitepress (docs)
+
+/docs/.vitepress/cache
+/docs/.vitepress/dist
+
+.vitepress/cache
+.vitepress/dist

docs/.vitepress/config.mts

@@ -0,0 +1,57 @@
+import { defineConfig } from 'vitepress'
+
+// https://vitepress.dev/reference/site-config
+export default defineConfig({
+  title: "Jecs",
+  base: "/jecs/",
+  description: "A VitePress Site",
+  themeConfig: {
+    // https://vitepress.dev/reference/default-theme-config
+    nav: [
+      { text: 'Home', link: '/' },
+      { text: 'Examples', link: '/markdown-examples' }
+    ],
+
+    sidebar: [
+      {
+        text: 'Overview',
+        items: [
+          { text: 'Getting Started', link: '/overview/get-started' },
+          { text: 'First Jecs Project', link: '/overview/first-jecs-project' }
+        ]
+      },
+      {
+        text: 'Concepts',
+        items: [
+          { text: 'Entities', link: '/concepts/entities' },
+          { text: 'Static Components', link: '/concepts/static-components' },
+          { text: 'Queries', link: '/concepts/queries' },
+        ]
+      },
+      {
+        text: 'References',
+        items: [
+          { text: 'API Reference', link: '/api' },
+        ]
+      },
+      {
+        text: "FAQ",
+        items: [
+          { text: 'How can I contribute?', link: '/faq/contributing' }
+        ]
+      },
+      {
+        text: 'Contributing',
+        items: [
+          { text: 'Contribution Guidelines', link: '/contributing/guidelines'},
+          { text: 'Submitting Issues', link: '/contributing/issues'},
+          { text: 'Submitting Pull Requests', link: '/contributing/pull-requests'},
+        ]
+      }
+    ],
+
+    socialLinks: [
+      { icon: 'github', link: 'https://github.com/vuejs/vitepress' }
+    ]
+  }
+})

docs/api.md

@@ -0,0 +1,59 @@
+# API
+
+## World
+
+### World.new() -> `World`
+Creates a new world.
+
+Example:
+::: code-group
+
+```luau [luau]
+local world = jecs.World.new()
+```
+
+```ts [typescript]
+import { World } from "@rbxts/jecs";
+
+const world = new World();
+```
+
+:::
+
+### world:entity() -> `Entity<T>`
+Creates a new entity.
+
+Example:
+::: code-group
+
+```luau [luau]
+local entity = world:entity()
+```
+
+```ts [typescript]
+const entity = world.entity();
+```
+
+:::
+
+### world:component() -> `Entity<T>`
+Creates a new static component. Keep in mind that components are also entities.
+
+Example:
+::: code-group
+
+```luau [luau]
+local Health = world:component()
+```
+
+```ts [typescript]
+const Health = world.component<number>();
+```
+
+:::
+
+::: info
+You should use this when creating static components.
+
+For example, a generic Health entity should be created using this.
+:::