Skip to content

Commit

Permalink
feat: docs updates and automated release process (#50)
Browse files Browse the repository at this point in the history
* docs update

* feat(build): add changelog generation tool and commit hooks

* feat: release script for automated releases
  • Loading branch information
liana-p committed Apr 11, 2023
1 parent 984de73 commit 58fe210
Show file tree
Hide file tree
Showing 8 changed files with 1,365 additions and 10 deletions.
2 changes: 2 additions & 0 deletions docs/features/achievements.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,3 +60,5 @@ main:
## Achievements UI

The achievements UI will automatically appear as a tab in the game menu if the game has any achievements defined.

![Achievements UI](./images/achievements.png)
Binary file added docs/features/images/achievements.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 0 additions & 4 deletions docs/guides/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,6 @@ description: >-
minute
---

::: danger
This is the **new documentation website**. It is better than the old one but might be missing some pages or have issues. If you need to refer to the old docs please go to [docs-old.get-narrat.com](https://docs-old.get-narrat.com)
:::

::: tip
Getting started with narrat is very quick. There is a ready-to-use template that can get you running your game in a minute
:::
Expand Down
17 changes: 14 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{
"name": "narrat-monorepo",
"version": "2.11.1",
"private": true,
"type": "module",
"engines": {
Expand All @@ -17,7 +18,9 @@
"lint": "pnpm -r --parallel --filter=./packages/* run lint",
"docs:dev": "npx vitepress dev docs",
"docs:build": "npx vitepress build docs",
"docs:serve": "npx vitepress serve docs"
"docs:serve": "npx vitepress serve docs",
"changelog": "conventional-changelog -p angular -i CHANGELOG.md -s",
"postinstall": "simple-git-hooks"
},
"repository": {
"type": "git",
Expand All @@ -35,10 +38,18 @@
"narrat": "workspace:*"
}
},
"simple-git-hooks": {
"commit-msg": "node scripts/verifyCommit.js"
},
"devDependencies": {
"chalk": "^5.2.0",
"conventional-changelog-cli": "^2.2.2",
"enquirer": "^2.3.6",
"execa": "^4.0.2",
"minimist": "^1.2.6",
"rimraf": "^3.0.2",
"semver": "^7.4.0",
"simple-git-hooks": "^2.8.1",
"vitepress": "1.0.0-alpha.19"
},
"version": "0.0.1"
}
}
2 changes: 1 addition & 1 deletion packages/create-narrat/template/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"description": "Template for Narrat game engine",
"main": "electron-main.js",
"engines": {
"node": "16.x"
"node": ">=16.x"
},
"build": {
"files": [
Expand Down
Loading

0 comments on commit 58fe210

Please sign in to comment.