Add XCM SDK docs (#248)

.github/pull-request-template.md

@@ -4,7 +4,7 @@ Please explain the changes this PR addresses here.
 
 ### Checklist
 
-- [ ] If this requires a documentation change, I have created a PR in [moonbeam-docs](https://github.com/moonbeam-foundation/moonbeam-docs) repository.
+- [ ] If this requires a documentation change, I have created a PR that updates the `mkdocs/docs` directory
 - [ ] If this requires it, I have updated the Readme
 - [ ] If necessary, I have updated the examples
 - [ ] I have verified if I need to create/update unit tests

.gitignore

@@ -114,3 +114,6 @@ dist
 
 # IntelliJ Idea
 .idea
+
+# Docs - Site directory
+mkdocs/site

mkdocs/README.md

@@ -0,0 +1,39 @@
+# Documentation for the XCM SDK
+
+## Publishing New Versions
+
+To add the very first version, you’ll need to push the latest changes to the `main` branch and then in your terminal run:
+
+```bash
+mike deploy --push INSERT_NEW_VERSION latest
+```
+
+Where the version should be formatted like `v0`, as we only need to worry about maintaining documentation for major version changes.
+
+For additional versions, you'll need to run:
+
+```bash
+mike deploy --push --update-aliases INSERT_NEW_VERSION latest
+```
+
+## Publishing Changes to a Specific Version
+
+To make minor updates to the current version or an older version, you’ll need to make the changes to the `main` branch and then in your terminal run:
+
+```bash
+mike deploy --push INSERT_VERSION
+```
+
+If using the latest version, you can cross-reference the live website, or the `gh-pages` branch to get the version that needs to be provided to the above command.
+
+Please note that modifying a previous version is possible, but should not be done unless necessary. It will require you to roll back changes to that version. For example, if the current version is v2 and you make a change and want to apply it to v0, the rest of the pages must be on v0, otherwise, the v2 changes will be applied to v0.
+
+## Setting a Default Version
+
+After setting the `latest` alias as the default version, and when publishing a new version, always update the alias to point to the latest version by running:
+
+```bash
+mike set-default --push latest
+```
+
+When publishing a new version, this will create a redirect in the root of the documentation to the version associated with the alias. So, `https://moonbeam-foundation.github.io/xcm-sdk/` will redirect to `https://moonbeam-foundation.github.io/xcm-sdk/latest/`.

mkdocs/docs/.pages

@@ -0,0 +1,5 @@
+nav:
+ - 'index.md'
+ - 'SDK Reference': 'reference'
+ - 'Using the XCM SDK': 'example-usage.md'
+ - 'Contribute': 'contribute.md'

mkdocs/docs/.snippets/text/endpoint-setup.md

@@ -0,0 +1 @@
+To configure your project for Moonbeam or Moonriver, you will need to have your own endpoint and API key, which you can get from one of the supported [Endpoint Providers](https://docs.moonbeam.network/builders/get-started/endpoints){target=\_blank}.

mkdocs/docs/.snippets/text/third-party-content.md

@@ -0,0 +1,3 @@
+<div class="page-disclaimer"> 
+The information presented herein has been provided by third parties and is made available solely for general information purposes. Moonbeam does not endorse any project listed and described on the Moonbeam Doc Website (https://docs.moonbeam.network/). Moonbeam Foundation does not warrant the accuracy, completeness or usefulness of this information. Any reliance you place on such information is strictly at your own risk. Moonbeam Foundation disclaims all liability and responsibility arising from any reliance placed on this information by you or by anyone who may be informed of any of its contents. All statements and/or opinions expressed in these materials are solely the responsibility of the person or entity providing those materials and do not necessarily represent the opinion of Moonbeam Foundation. The information should not be construed as professional or financial advice of any kind. Advice from a suitably qualified professional should always be sought in relation to any particular matter or circumstance. The information herein may link to or integrate with other websites operated or content provided by third parties, and such other websites may link to this website. Moonbeam Foundation has no control over any such other websites or their content and will have no liability arising out of or related to such websites or their content. The existence of any such link does not constitute an endorsement of such websites, the content of the websites, or the operators of the websites. These links are being provided to you only as a convenience and you release and hold Moonbeam Foundation harmless from any and all liability arising from your use of this information or the information provided by any third-party website or service.
+</div>