diff --git a/.idea/workspace.xml b/.idea/workspace.xml index 75f83c769..c0fadd107 100644 --- a/.idea/workspace.xml +++ b/.idea/workspace.xml @@ -5,55 +5,10 @@ + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + { + "lastFilter": { + "state": "OPEN", + "assignee": "SrIzan10" + } +} @@ -103,7 +64,9 @@ "RunOnceActivity.OpenProjectViewOnStart": "true", "RunOnceActivity.ShowReadmeOnStart": "true", "WebServerToolWindowFactoryState": "false", + "git-widget-placeholder": "feat/tutorial", "last_opened_file_path": "C:/Users/jacob/OneDrive/Desktop/Projects/sern/website", + "node.js.selected.package.tslint": "(autodetect)", "nodejs_package_manager_path": "npm", "project.structure.last.edited": "Modules", "project.structure.proportion": "0.0", @@ -113,6 +76,7 @@ } + diff --git a/docs/tutorial/intro/whats-sern.md b/docs/tutorial/en/intro/whats-sern.md similarity index 72% rename from docs/tutorial/intro/whats-sern.md rename to docs/tutorial/en/intro/whats-sern.md index 55d15199a..e0ff96c66 100644 --- a/docs/tutorial/intro/whats-sern.md +++ b/docs/tutorial/en/intro/whats-sern.md @@ -1,6 +1,10 @@ -# What is sern? +--- +title: What is sern? +--- -We're a discord bot framework. The lack of tooling in the discord.js community is apparent, and is also monolithic. You can make botseasily with our suite of tools, and with conciseness. We're also a community. PLS join [here](https://sern.dev/discord) 😼. + + +We're a discord bot framework. The lack of tooling in the discord.js community is apparent, and is also monolithic. You can make bots easily and concisely with our suite of tools. We're also a community. Please join [here](https://sern.dev/discord)! ### Problem @@ -9,7 +13,7 @@ We're a discord bot framework. The lack of tooling in the discord.js community i - **lack of wholesome community in discord.js** - **lack of modularity** -sern tries to solve all these problems. This tutorial is for anyone and everyone, beginners and advanced a like. +sern tries to solve all these problems. This tutorial is for anyone and everyone, beginners and advanced alike. ## Solution diff --git a/docs/tutorial/en/preparing/package-manager.md b/docs/tutorial/en/preparing/package-manager.md new file mode 100644 index 000000000..6828db5d1 --- /dev/null +++ b/docs/tutorial/en/preparing/package-manager.md @@ -0,0 +1,20 @@ +--- +title: Choosing a package manager +--- + + + +A package manager is like a helper for your programs. It brings all the tools for your projects and makes sure they fit and work well together. It's like having someone organize things so you can work without problems. + +Some examples are +- [npm](https://www.npmjs.com) +- [Yarn](https://yarnpkg.com) +- [pnpm](https://pnpm.io/) + +For this tutorial, we'll be using **[Yarn](https://yarnpkg.com)**. It's made by Facebook. + +**Advantages of Yarn:** +1. **Performance:** Yarn is fast and has efficient dependency management. +2. **Lockfile:** Yarn's `yarn.lock` file ensures deterministic builds, crucial for collaboration. +3. **Offline Mode:** Yarn offers a reliable offline mode, ideal for environments with limited internet access. +4. **Plug-n-play:** Yarn Berry (2) introduces "plug-n-play" (PnP), reducing disk space usage. \ No newline at end of file diff --git a/docs/tutorial/langchooser.md b/docs/tutorial/langchooser.md new file mode 100644 index 000000000..7828ee3d7 --- /dev/null +++ b/docs/tutorial/langchooser.md @@ -0,0 +1,6 @@ +# Welcome! + +Choose your language: +- [en](./en/intro/whats-sern) +- [es (WIP)](./es) +- [tr (WIP)](./tr) \ No newline at end of file diff --git a/docs/tutorial/preparing/package-manager.md b/docs/tutorial/preparing/package-manager.md deleted file mode 100644 index 49d5d1b0a..000000000 --- a/docs/tutorial/preparing/package-manager.md +++ /dev/null @@ -1,18 +0,0 @@ -A package manager is like a helper for your programs. It brings all the tools for your projects and makes sure they fit and work well together. It's like having someone organize things so you can work without problems. - -Some examples are -- [npm](https://www.npmjs.com) -- [Yarn](https://yarnpkg.com) -- [pnpm](https://pnpm.io/) - -For this tutorial, we'll be using **[Yarn](https://yarnpkg.com)**. It's made by Facebook. - -**Advantages of Yarn:** -1. **Performance:** Yarn is fast enough and has efficient dependency management. -2. **Lockfile:** Yarn's `yarn.lock` file ensures deterministic builds, crucial for collaboration. -4. **Offline Mode:** Yarn offers a reliable offline mode, ideal for environments with limited internet access. -5. **Selective Installs:** You can choose to install specific packages without affecting the entire dependency tree. -6. **Plug-n-play:** Yarn 2 introduces "plug-n-play" (PnP), reducing disk space usage. - -**Choice of Package Manager:** -For this tutorial, we will use Yarn as the package manager. Yarn offers several advantages like above and it's a great choice to streamline development and ensure consistency, especially in collaborative environments. Both npm and Yarn are excellent package managers, and your choice will depend on your specific project requirements and personal preferences. Regardless of which package manager you choose, make sure to document your choice and ensure that your team members are on the same page to avoid potential issues during development.