From 2d398183e9342f04ecf9bd2674bdecf9bda07ebd Mon Sep 17 00:00:00 2001 From: Kwoth Date: Sun, 5 Sep 2021 11:33:03 +0200 Subject: [PATCH] Updated links to be relative, updated readme with black theme. Small updates --- .gitignore | 3 ++- CHANGELOG.md | 10 ++++++---- README.md | 8 +++++--- docs/guides/linux-guide.md | 4 ++-- docs/guides/migration-guide.md | 2 +- docs/guides/windows-guide.md | 2 +- docs/jsons-explained.md | 2 +- 7 files changed, 18 insertions(+), 13 deletions(-) diff --git a/.gitignore b/.gitignore index 0b6aa59f0..c79b3a910 100644 --- a/.gitignore +++ b/.gitignore @@ -8,7 +8,8 @@ src/NadekoBot/creds.yml src/NadekoBot/Command Errors*.txt src/NadekoBot/creds.yml -# credentials file after migrations +# credentials file before and after migrations +src/NadekoBot/credentials.json src/NadekoBot/old_credentials.json src/NadekoBot/credentials.json.bak src/NadekoBot/data/NadekoBot.db diff --git a/CHANGELOG.md b/CHANGELOG.md index 939eeef15..8476aef1c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,16 +8,18 @@ Experimental changelog. Mostly based on [keepachangelog](https://keepachangelog. - Renamed `credentials.json` to `creds.yml` (example in `creds_example.yml`) - Most of the credentials from 2.x will be automatically migrated + - Explanations on how to get the keys are added as the comments - Code cleanup - Command attributes cleaned up - Removed dummy Remarks and Usages attributes as hey were unused for a few patches but stayed in the code to avoid big git diffsmigration code has ran and it can be safely removed - There are 2 projects: NadekoBot and NadekoBot.Coordinator - You can directly run NadekoBot as the regular bot with one shard - Run NadekoBot.Coordinator if you want more control over your shards and a grpc api for coordinator with which you can start, restart, kill and see status of shards - - todo: Reworked from source installation (linux/windows) guide - - todo: Added docker support, installation guide at -- Guides -- Now instruct users to set build output to nadekobot/output instead of running from nadekobot/src/NadekoBot + - Small performance improvements + - Db Migrations squashed + - A lot of cleanup all around +- Many guides reworked + - Guides now instruct users to set build output to nadekobot/output instead of running from nadekobot/src/NadekoBot ### Fixed diff --git a/README.md b/README.md index baddb0f4a..ffb550e29 100644 --- a/README.md +++ b/README.md @@ -3,9 +3,11 @@ [![Discord Bots](https://discordbots.org/api/widget/status/116275390695079945.svg)](https://top.gg/bot/116275390695079945) -[![nadeko0](https://cdn.discordapp.com/attachments/266240393639755778/281920716809699328/part1.png)](https://nadeko.bot/) -[![nadeko1](https://cdn.discordapp.com/attachments/266240393639755778/281920134967328768/part2.png)](https://invite.nadeko.bot/) -[![nadeko2](https://cdn.discordapp.com/attachments/266240393639755778/281920161311883264/part3.png)](https://nadeko.bot/commands) +[![nadeko0](https://cdn.nadeko.bot/tutorial/docs-top.png)](https://nadeko.bot/) + +[![nadeko1](https://cdn.nadeko.bot/tutorial/docs-mid.png)](https://invite.nadeko.bot/) + +[![nadeko2](https://cdn.nadeko.bot/tutorial/docs-bot.png)](https://nadeko.bot/commands) ### Useful links - ❗ [2.x to v3 migration guide](https://nadekobot.readthedocs.io/en/v3/guides/migration-guide/) diff --git a/docs/guides/linux-guide.md b/docs/guides/linux-guide.md index 6d87b063e..9cec7b11f 100644 --- a/docs/guides/linux-guide.md +++ b/docs/guides/linux-guide.md @@ -2,7 +2,7 @@ ##### ⚠ If you're already hosting NadekoBot, _You **MUST** update to latest version of 2.x and **run your bot at least once**_ before switching over to v3. -#### [Linux migration instructions](https://nadekobot.readthedocs.io/en/v3/guides/migration-guide/#linux) +#### [Linux migration instructions](../migration-guide/#linux) ## Linux From Source @@ -17,7 +17,7 @@ Open Terminal (if you're on an installation with a window manager) and navigate 5. Copy the creds.yml template `cp nadekobot/output/creds_example.yml nadekobot/output/creds.yml` 6. Open `nadekobot/output/creds.yml` with your favorite text editor. We will use nano here - `nano nadekobot/output/creds.yml` -7. [Enter your bot's token](https://nadekobot.readthedocs.io/en/v3/creds-guide/) +7. [Enter your bot's token](../../creds-guide) - After you're done, you can close nano (and save the file) by inputting, in order - `CTRL` + `X` - `Y` diff --git a/docs/guides/migration-guide.md b/docs/guides/migration-guide.md index 33918c909..07bba18c5 100644 --- a/docs/guides/migration-guide.md +++ b/docs/guides/migration-guide.md @@ -32,7 +32,7 @@ - `.stats` to ensure owner id (credentials) is correct - `.lcr` to see custom reactions - `.lp` to list permissions -5. 🎉 Enjoy. If you want to learn how to update the bot, click (here)[https://nadekobot.readthedocs.io/en/v3/guides/linux-guide/#update-instructions]. +5. 🎉 Enjoy. If you want to learn how to update the bot, click (here)[../linux-guide/#update-instructions]. ## Manual diff --git a/docs/guides/windows-guide.md b/docs/guides/windows-guide.md index 7219bf2e5..dc89319ae 100644 --- a/docs/guides/windows-guide.md +++ b/docs/guides/windows-guide.md @@ -2,7 +2,7 @@ ⚠ If you're already hosting NadekoBot, You **MUST** update to latest version of 2.x and **run your bot at least once** before switching over to v3. -#### [Windows migration instructions](migration-instructions#windows) +#### [Windows migration instructions](../migration-guide#windows) ## Setting Up NadekoBot on Windows With the Updater diff --git a/docs/jsons-explained.md b/docs/jsons-explained.md index decffdd0a..ffc68c6f1 100644 --- a/docs/jsons-explained.md +++ b/docs/jsons-explained.md @@ -18,7 +18,7 @@ This part is completely optional, **however it's necessary for music and a few o - Open up `creds.yml` and look for `GoogleAPIKey`, paste your API key after the `:`. - It should look like this: ```yml - "GoogleApiKey": "AIzaSyDSci1sdlWQOWNVj1vlXxxxxxbk0oWMEzM", + GoogleApiKey: "AIzaSyDSci1sdlWQOWNVj1vlXxxxxxbk0oWMEzM", ``` - **MashapeKey** - Required for Hearthstone cards.