mirror of
https://github.com/zkldi/Tachi.git
synced 2026-10-04 12:58:11 +03:00
docs: rename zk to something more memorable
This commit is contained in:
@@ -19,4 +19,4 @@ lamps for the game.
|
||||
|
||||
*****
|
||||
|
||||
This documentation is unfinished. It is probably easier for you to [just read the config.ts file](https://github.com/zkldi/Tachi/tree/main/common/src/config/config.ts)
|
||||
This documentation is unfinished. It is probably easier for you to [just read the config.ts file](https://github.com/zkrising/Tachi/tree/main/common/src/config/config.ts)
|
||||
|
||||
@@ -10,7 +10,7 @@ representing the same thing.
|
||||
|
||||
## Hashing
|
||||
|
||||
To create the Goal ID, we perform a [json stable hash](https://github.com/zkldi/fast-json-stable-hash) on the
|
||||
To create the Goal ID, we perform a [json stable hash](https://github.com/zkrising/fast-json-stable-hash) on the
|
||||
`game`, `playtype`, `charts` and `criteria` of this field.
|
||||
|
||||
This enforces that goals are unique on those fields.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Codebase Overview
|
||||
|
||||
This part of the documentation is for the [Tachi-Server](https://github.com/zkldi/Tachi/tree/main/server) codebase.
|
||||
This part of the documentation is for the [Tachi-Server](https://github.com/zkrising/Tachi/tree/main/server) codebase.
|
||||
|
||||
## Codebase Documentation vs. Code Documentation
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Database Seeds
|
||||
|
||||
Tachi tracks the contents of its songs and charts in something called the [Database Seeds](https://github.com/zkldi/Tachi/tree/main/database-seeds).
|
||||
Tachi tracks the contents of its songs and charts in something called the [Database Seeds](https://github.com/zkrising/Tachi/tree/main/database-seeds).
|
||||
|
||||
The databases in question aren't (normally) altered by the server code. We essentially overload git and its CI tools to version control parts of our database.
|
||||
|
||||
|
||||
@@ -6,7 +6,7 @@ of winston, but the same basic logging principles apply.
|
||||
|
||||
!!! note
|
||||
If you like my defaults for logging, they can be quickly
|
||||
invoked with the [Mei](https://github.com/zkldi/mei) wrapper.
|
||||
invoked with the [Mei](https://github.com/zkrising/mei) wrapper.
|
||||
|
||||
*****
|
||||
|
||||
@@ -144,7 +144,7 @@ logger with the user's name and import type as "context".
|
||||
const logger = CreateLogCtx(`${username} ${userID}`);
|
||||
|
||||
logger.info("foo");
|
||||
// [zkldi 1] INFO: foo
|
||||
// [zkrising 1] INFO: foo
|
||||
|
||||
SomeOtherFunction(argument1, argument2, logger);
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user