start adding documentation for new languages

Author: makspll

CONTRIBUTING.MD

@@ -135,8 +135,7 @@ Enhancement suggestions are tracked as [GitHub issues](https://github.com/makspl
 
 ### Your First Code Contribution
 
-This project uses xtask to manage the build and test process. You can run `cargo xtask` to see the available commands. Run `xtask init` to setup your local development environment.
-
+Before contributing see the [book](https://makspll.github.io/bevy_mod_scripting) for helpful guides on how to get started with the project.
 
 
 ### Improving The Documentation

docs/src/Development/AddingLanguages/evaluating-feasibility.md

@@ -0,0 +1,8 @@
+# Evaluating Feasibility
+
+In order for a language to work well with BMS it's necessary it supports the following features:
+- [ ] Interoperability with Rust. If you can't call it from Rust easilly and there is no existing crate that can do it for you, it's a no-go.
+- [ ] First class functions. Or at least the ability to call an arbitrary function with an arbitrary number of arguments from a script. Without this feature, you would need to separately generate code for the bevy bindings. This is painful and goes against the grain of the project.
+
+## First Classs Functions
+

docs/src/Development/AddingLanguages/introduction.md

@@ -0,0 +1,3 @@
+# Adding New Languages to BMS
+
+If you are interested in adding a new language to BMS, please read this section first. Adding a new language is a non-trivial task depending on the language you want to add. It also requires a lot of effort and time to maintain a new language, so unless the language you want to add is widely used and has a large community, it might not be worth the effort.

docs/src/Development/introduction.md

@@ -0,0 +1,7 @@
+# Developing BMS
+
+This section is for developers who want to contribute to the BMS project. It covers various topics necessary for understanding the project and contributing to it.
+
+## Contributing
+
+Please see the [code of conduct](https://github.com/makspll/bevy_mod_scripting/blob/main/CODE_OF_CONDUCT.md) as well as the [contributing guidelines](https://github.com/makspll/bevy_mod_scripting/blob/main/CONTRIBUTING.md) first.

docs/src/Development/setup.md

@@ -0,0 +1,32 @@
+# Setup
+
+this crate contains a work in progress `xtask` setup which in theory should allow you to setup everything you need for local development by running:
+
+```sh
+cargo xtask init
+```
+
+However at the moment it does not generate IDE specific files for you, so you will need to do that manually.
+
+## VScode
+
+For vscode you will want to enter the following into your `settings.json`
+
+```json
+{
+    "rust-analyzer.rustc.source": "discover",
+    "rust-analyzer.linkedProjects": [
+        // "./crates/bevy_api_gen/Cargo.toml", uncommenting this is currently not fully supported with xtask + vscode, rust analyzer bugs out a lot sadly
+        "Cargo.toml",
+    ],
+    "rust-analyzer.check.invocationStrategy": "once",
+    "rust-analyzer.check.overrideCommand": [
+        "/absolute-path-to-this-project/bevy_mod_scripting/check.sh"
+    ],
+    "rust-analyzer.cargo.buildScripts.overrideCommand": [
+        "/absolute-path-to-this-project/bevy_mod_scripting/check.sh"
+    ],
+}
+```
+
+If you are on windows you might need to create an equivalent `check.exe` to run `cargo xtask check --ide-mode` in the root directory of this workspace.

docs/src/SUMMARY.md

@@ -18,3 +18,10 @@
     - [ScriptQueryBuilder](./ScriptingReference/script-query-builder.md)
     - [ScriptQueryResult](./ScriptingReference/script-query-result.md)
 - [Core Callbacks](./ScriptingReference/core-callbacks.md)
+
+# Developing BMS
+
+- [Introduction](./Development/introduction.md)
+    - [Setup](./Development/setup.md) 
+- [New Languages](./Development/AddingLanguages/introduction.md)
+    - [Evaluating Feasibility](./Development/AddingLanguages/evaluating-feasibility.md)