Merge remote-tracking branch 'origin/main'

.github/workflows/ci.yml

@@ -1,4 +1,4 @@
-name: CI/CD Workflow
+name: Code Quality
 
 permissions:
   pull-requests: write
@@ -17,7 +17,7 @@ on:
       - main
 
 jobs:
-  pipeline:
+  code-quality:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repository

.github/workflows/ci_writerside_docs.yml → .github/workflows/documentation.yml

@@ -1,11 +1,10 @@
-name: Build, Test, and Deploy Documentation
+name: Writerside Documentation
 
 on:
-  push:
-    branches: ['main']
   pull_request:
-    branches: ['main']
-  workflow_dispatch:
+  push:
+    branches:
+      - main
 
 permissions:
   contents: write
@@ -18,7 +17,7 @@ env:
   DOCKER_VERSION: '242.21870' # Specific Docker version
 
 jobs:
-  build-and-deploy:
+  build-and-deploy-docs:
     runs-on: ubuntu-latest
 
     steps:
@@ -40,7 +39,7 @@ jobs:
         with:
           name: docs
           path: |
-            artifacts/${{ env.ARTIFACT }}  # Artifact inside the artifacts folder
+            artifacts/${{ env.ARTIFACT }} 
             artifacts/report.json
           retention-days: 7
 
@@ -61,7 +60,7 @@ jobs:
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
 
-  test:
+  test-docs:
     runs-on: ubuntu-latest
     needs: build-and-deploy
 

README.md

@@ -1,5 +1,7 @@
 # Kurocado Studio Style Guide
 
+[Read the docs](https://kurocado-studio.github.io/styleguide/starter-topic.html)
+
 This repository contains the style guide for our project, specifically tailored for TypeScript. We
 have used the Vercel Style Guide as a base for our TypeScript configurations, and aspire to maintain
 the same high standards in our code quality.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kurocado-studio/style-guide",
-  "version": "1.1.0",
+  "version": "1.2.1",
   "description": "Kurocado Studio's engineering style guide",
   "homepage": "https://github.com/Kurocado-Studio/styleguide",
   "bugs": {
@@ -12,12 +12,6 @@
   },
   "license": "MPL-2.0",
   "exports": {
-    "./gh-actions/base": "./.github/workflows/_base.yml",
-    "./gh-actions/commitlint": "./.github/workflows/commitlint.yml",
-    "./gh-actions/deploy_writerside_docs": "./.github/workflows/deploy_writerside_docs.yml",
-    "./gh-actions/eslint_check": "./.github/workflows/eslint_check.yml",
-    "./gh-actions/npm_publish": "./.github/workflows/npm_publish.yml",
-    "./gh-actions/prettier_check": "./.github/workflows/prettier_check.yml",
     "./commitlint": "./src/commitlint/index.js",
     "./semantic-release": "./src/semantic-release/index.js",
     "./eslint/base": "./src/eslint/eslint.base.js",
@@ -34,7 +28,14 @@
     "./tsconfig/web": "./src/tsconfig/tsconfig.web.json"
   },
   "main": "index.js",
-  "files": ["src/eslint", "src/prettier", "src/tsconfig"],
+  "files": [
+    "src/.github",
+    "src/commitlint",
+    "src/eslint",
+    "src/prettier",
+    "src/semantic-release",
+    "src/tsconfig"
+  ],
   "scripts": {
     "commitlint": "pnpm exec commitlint --edit",
     "eslint-check": "eslint --max-warnings=0 .",