From 7f0f273652e19f95325f7f8e9593363014bbfaa2 Mon Sep 17 00:00:00 2001 From: shidorien Date: Wed, 20 Nov 2024 20:37:50 +0100 Subject: [PATCH] update home.md and add mardownlint.json --- .markdownlint.json | 4 ++++ docs/wiki/Home.md | 41 +++++++++++++++++++++++++++++++---------- 2 files changed, 35 insertions(+), 10 deletions(-) create mode 100644 .markdownlint.json diff --git a/.markdownlint.json b/.markdownlint.json new file mode 100644 index 00000000..e5bcd965 --- /dev/null +++ b/.markdownlint.json @@ -0,0 +1,4 @@ +{ + "MD007": { "indent": 4 }, + "MD013": false +} diff --git a/docs/wiki/Home.md b/docs/wiki/Home.md index 71e2d876..3dc4c073 100644 --- a/docs/wiki/Home.md +++ b/docs/wiki/Home.md @@ -1,16 +1,37 @@ -Welcome to the bs-manager wiki! (wip c:) +# Welcome to the BSManager Wiki -to get you oculus token check here : https://github.com/Zagrios/bs-manager/wiki/How-to-obtain-your-Oculus-Token +BSManager is your all-in-one tool designed to simplify and enhance your Beat Saber experience. With BSManager, you can effortlessly manage game versions, mods, maps, and more, ensuring a seamless and enjoyable gameplay journey. ---- +## 📚 Guides -This Wiki accepts contributions! +Our comprehensive guides are crafted to assist you in maximizing BSManager's capabilities: -To contribute to the wiki: +- **🛠️ Installation and Updates**: Step-by-step instructions to install BSManager on your system and keep it up-to-date. + - [Install or import a version]() + - [Create a shortcut (Windows/Linux/Steam)]() +- **🔑 Login**: Guidance on logging into BSManager to access all features. + - [Get your Oculus token]() +- **🎮 Content Management**: + - **🗺️ Maps**: Learn how to download and organize custom maps for endless entertainment. + - [Install any maps]() + - [Install all playlists you want]() + - **🧩 Mods**: Discover how to install, update, and manage mods to enhance your gameplay. + - [Install your mods in BSManager]() + - **🖼️ Models**: Find out how to integrate custom models into your Beat Saber experience. + - [Modify your models]() +- **🛠️ Support**: Solutions to common issues and answers to frequently asked questions to ensure a smooth experience with BSManager. + - [Send your logs]() +- **🤝 Contribution**: Information on how to contribute to the development and improvement of BSManager. -- Fork the project -- Add/Edit `.md` files in the `docs/wiki/` folder -- Create a Pull Request -- Once the PR is merged (after review), it will be present in the repository's wiki +## Troubleshoots -test 2 +blablabla + + +---- + +We are committed to keeping this wiki up-to-date with the latest information and best practices. Your contributions are welcome; please refer to our [contribution guidelines](https://github.com/Zagrios/bs-manager/wiki) to get started. + +For additional support and community interaction, join our [Discord server](https://discord.gg/bsmanager). + +Thank you for using BSManager!