Skip to content

Commit

Permalink
docs: tidy up more
Browse files Browse the repository at this point in the history
  • Loading branch information
scarf005 committed Sep 11, 2023
1 parent 31c8476 commit bfdbadc
Show file tree
Hide file tree
Showing 30 changed files with 245 additions and 80 deletions.
12 changes: 6 additions & 6 deletions README.ko.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# 카타클리즘: 밝은 밤

<header align="center">
<a><img src="doc/img/readme-title.png" title="우측 위부터 시계방향으로 Chaosvolt (x2), ExecutorBill, scarf005의 스크린샷"></a>
<a><img src="doc/src/content/docs/en/contributing/img/readme-title.png" title="우측 위부터 시계방향으로 Chaosvolt (x2), ExecutorBill, scarf005의 스크린샷"></a>

[![en][icon-en]][en] [![ko][icon-ko]][ko]

Expand Down Expand Up @@ -105,11 +105,11 @@

게임 내에서 `Submit a bug report on github`를 실행하여 이슈를 제출할 수 있습니다.

| 1. 옵션 (ESC) -> 디버그 메뉴 (a) | 2. 정보 (i) |
| :------------------------------: | :--------------------------: |
| ![](doc/img/readme-bug1.png) | ![](doc/img/readme-bug2.png) |
| 3. 버그 리포트 제출 (U) | 4. 이슈 링크가 생성됩니다 |
| ![](doc/img/readme-bug3.png) | ![](doc/img/readme-bug4.png) |
| 1. 옵션 (ESC) -> 디버그 메뉴 (a) | 2. 정보 (i) |
| :-----------------------------------------------------------: | :-----------------------------------------------------------: |
| ![](doc/src/content/docs/en/contributing/img/readme-bug1.png) | ![](doc/src/content/docs/en/contributing/img/readme-bug2.png) |
| 3. 버그 리포트 제출 (U) | 4. 이슈 링크가 생성됩니다 |
| ![](doc/src/content/docs/en/contributing/img/readme-bug3.png) | ![](doc/src/content/docs/en/contributing/img/readme-bug4.png) |

`버전 및 환경 설정(Version and configuration)` 항목이 채워진 이슈가 브라우저에서 열립니다.

Expand Down
19 changes: 6 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,10 @@
# Cataclysm: Bright Nights

<header align="center">
<a><img src="doc/img/readme-title.png" title="screenshots of (clockwise from upper-right: Chaosvolt (x2), ExecutorBill, scarf005"></a>

[![en][icon-en]][en] [![ko][icon-ko]][ko]
<a><img src="doc/src/content/docs/en/contributing/img/readme-title.png" title="screenshots of (clockwise from upper-right: Chaosvolt (x2), ExecutorBill, scarf005"></a>

</header>

[en]: ./README.md
[icon-en]: https://img.shields.io/badge/lang-en-red?style=flat-square
[ko]: ./README.ko.md
[icon-ko]: https://img.shields.io/badge/lang-ko-orange?style=flat-square

Cataclysm: Bright Nights is a roguelike with sci-fi elements set in a post-apocalyptic world.

While some have described it as a "zombie game", there is far more to Cataclysm than that. Struggle
Expand Down Expand Up @@ -107,11 +100,11 @@ be submitted via debug menu.

Run `Submit a bug report on github` inside the game to submit an issue.

| 1. open Options (ESC) -> Debug Menu (a) | 2. open Info (i) |
| :-------------------------------------: | :------------------------------: |
| ![](doc/img/readme-bug1.png) | ![](doc/img/readme-bug2.png) |
| 3. Submit a bug report on github (U) | 4. An link to issue is generated |
| ![](doc/img/readme-bug3.png) | ![](doc/img/readme-bug4.png) |
| 1. open Options (ESC) -> Debug Menu (a) | 2. open Info (i) |
| :-----------------------------------------------------------: | :-----------------------------------------------------------: |
| ![](doc/src/content/docs/en/contributing/img/readme-bug1.png) | ![](doc/src/content/docs/en/contributing/img/readme-bug2.png) |
| 3. Submit a bug report on github (U) | 4. An link to issue is generated |
| ![](doc/src/content/docs/en/contributing/img/readme-bug3.png) | ![](doc/src/content/docs/en/contributing/img/readme-bug4.png) |

It will open a bug report on browser with `Version and configuration` filled in.

Expand Down
91 changes: 90 additions & 1 deletion deno.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions doc/astro.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ export default defineConfig({
navbar: {
json: {
label: "JSON",
link: "/json/explanation/json_style",
link: "/json/tutorial/modding",
translations: { "ko-KR": "JSON 모딩" },
items: docModes("json"),
},
Expand All @@ -61,7 +61,7 @@ export default defineConfig({
},
dev: {
label: "Engine",
link: "/dev/guides/building/building",
link: "/dev/guides/building/cmake",
translations: { "ko-KR": "게임 엔진" },
items: docModes("dev"),
},
Expand Down
2 changes: 1 addition & 1 deletion doc/remark.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ const removeSuffix = (url: string) => url.replace(suffix, "")

export const fixRelativeLinks = () => (tree: Root) =>
visit(tree, "link", (node) => {
node.url = relativeUrl(removeSuffix(node.url))
node.url = relativeUrl(removeSuffix(node.url)).toLowerCase()
})

/**
Expand Down
21 changes: 11 additions & 10 deletions doc/src/content/docs/en/contributing/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,13 +73,12 @@ For more information:

## Documentation

<p align="middle">
<img src="/doc/img/contributing-doxy1.png" width="48%">
<img src="/doc/img/contributing-doxy2.png" width="48%">
</p>
<!--
![](./img/contributing-doxy1.png)
![](./img/contributing-doxy2.png)
Autogenerated documentation is hosted on
[GitHub Pages](https://cataclysmbnteam.github.io/Cataclysm-BN).
[GitHub Pages](https://cataclysmbnteam.github.io/Cataclysm-BN). -->

### Doxygen Comments

Expand All @@ -95,6 +94,8 @@ Use the following template for commenting classes:
* Lengthy description with many words. (optional)
*/
class foo {

}
```
Use the following template for commenting functions:
Expand Down Expand Up @@ -225,7 +226,7 @@ to explain the problem your PR is solving in full detail.
### All PRs should have a `"Summary"` line

Summary is a one-line description of your change that will be extracted and added to the project
changelog at <https://github.com/cataclysmbnteam/Cataclysm-BN/blob/upload/data/changelog.txt>
changelog at https://github.com/cataclysmbnteam/Cataclysm-BN/blob/upload/data/changelog.txt

The format is: `SUMMARY: Category "description"`

Expand All @@ -234,14 +235,14 @@ Performance, Infrastructure, Build, I18N.

Example: `SUMMARY: Content "Adds new mutation category 'Mouse'"`

See the [Changelog Guidelines](./changelog.md) for explanations of the categories.
See the [Changelog Guidelines](./changelog) for explanations of the categories.

### Closing issues using keywords

One more thing: when marking your PR as closing, fixing, or resolving issues, please include this
somewhere in the description:

```
```md
- {keyword} #{issue}
```

Expand All @@ -264,11 +265,11 @@ slightly faster.

### closing multiple issues at once

```
```md
- {keyword} #{issue}, {keyword} #{issue}
```

See <https://help.github.com/articles/closing-issues-using-keywords/> for more.
See https://help.github.com/articles/closing-issues-using-keywords for more.

## Tooling support

Expand Down
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
4 changes: 2 additions & 2 deletions doc/src/content/docs/en/dev/explanation/POINTS_COORDINATES.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,8 +75,8 @@ coordinates do. The z coordinate is relative to the vehicle origin.
## Point types

To work with these coordinate systems we have a variety of types. These are defined in
[`coordinates.h`](../../json/src/coordinates.h). For example, we have `point_abs_ms` for absolute map-square
coordinates. The three parts of the type name are _dimension_ `_` _origin_ `_` _scale_.
[`coordinates.h`](../../json/src/coordinates.h). For example, we have `point_abs_ms` for absolute
map-square coordinates. The three parts of the type name are _dimension_ `_` _origin_ `_` _scale_.

- **dimension** is either `point` for two-dimensional or `tripoint` for three-dimensional.
- **origin** specifies what the value is relative to, and can be:
Expand Down
4 changes: 2 additions & 2 deletions doc/src/content/docs/en/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ hero:
file: ../../../assets/icon.svg
actions:
- text: Read the Guide
link: ./dev/guides/building/cmake
link: ./json/tutorial/modding
icon: right-arrow
variant: primary
- text: Join the official Discord
Expand All @@ -22,7 +22,7 @@ import { Card, CardGrid } from '@astrojs/starlight/components'

<CardGrid stagger>
<Card title="Create custom mods" icon="pencil">
Mod the game using [JSON](json/reference/loading_order) and [Lua](./lua/guides/modding).
Mod the game using [JSON](json/tutorial/modding) and [Lua](lua/guides/modding).
</Card>
<Card title="Translate the game" icon="translate">
Translate the [base game](i18n/tutorial/transifex) and [custom mods](i18n/guides/mods).
Expand Down
Loading

0 comments on commit bfdbadc

Please sign in to comment.