Skip to content
This repository was archived by the owner on Jan 18, 2022. It is now read-only.

Commit e47e53b

Browse files
authored
Remove Docs from Master (#502)
* remove docs except for coding standards * docs linting + markdown formatting; * PR feedback
1 parent 573911a commit e47e53b

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+20
-2997
lines changed

.github/CONTRIBUTING.md

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,5 @@ later releases and we’ll keep you posted on this). However, we are taking issu
1111
See the [Contributions guide](https://improbableio.atlassian.net/wiki/x/foDrDw).
1212

1313
## Coding standards
14-
See the [Unity GDK C# coding standards guide](../docs/contributions/unity-gdk-coding-standards.md).
1514

16-
## Getting started
17-
See [About the SpatialOS Unity GDK](../docs/README.md) for
18-
details on how to get started using the Unity GDK.
19-
20-
## Warning
21-
This [alpha](https://docs.improbable.io/reference/latest/shared/release-policy#maturity-stages) release is for evaluation purposes only, with limited documentation -
22-
see the guidance on
23-
[Recommended use](../README.md#recommended-use).
15+
See the [GDK for Unity C# coding standards guide](../coding-standards.md).

README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,25 +8,24 @@ The SpatialOS Game Development Kit (GDK) for Unity enables game developers to bu
88

99
* the example game, which both tests and demonstrates the Feature Modules; for use as a starting point or resource for game development.
1010

11-
For further high-level information about this, see the [summary of key features](docs/content/faqs/key-features.md).
12-
1311
This is an alpha release of the GDK Core which is the foundation of the product. To find out more see the [GDK blogpost](https://improbable.io/games/blog/unity-gdk-our-first-steps).
1412

1513
---
16-
* [Setup Guide](docs/setup-and-installing.md)
17-
* [Documentation](docs/README.md)
14+
15+
* [Setup Guide](https://docs.improbable.io/unity/alpha/setup-and-installing#set-up-your-machine)
16+
* [Documentation](https://docs.improbable.io/unity/alpha/)
1817
* [Development Roadmap](https://trello.com/b/29tMKyQC)
19-
* [FAQs](docs/content/faqs/faqs.md)
2018
* [Discord](https://discord.gg/SCZTCYm)
2119
* [Forums](https://forums.improbable.io/latest?tags=unity-gdk)
2220
* [Github Issues](https://github.com/spatialos/UnityGDK/issues)
23-
* [Known Issues](docs/known-issues.md)
21+
* [Known Issues](https://docs.improbable.io/unity/alpha/known-issues)
2422
* [Sign up for e-mail updates](http://go.pardot.com/l/169082/2018-06-25/27mhsb)
23+
2524
---
2625

2726
## Recommended use
2827

29-
This alpha release is for experienced Unity developers who have some understanding of [SpatialOS concepts](https://docs.improbable.io/reference/13.0/shared/concepts/spatialos), and want to give early feedback.
28+
This alpha release is for experienced Unity developers who have some understanding of [SpatialOS concepts](https://docs.improbable.io/reference/latest/shared/concepts/spatialos), and want to give early feedback.
3029

3130
This alpha version software and its documentation is, by its very nature, rough and ready; every part of it is subject to change, including the APIs, and it isn’t optimised for performance. In addition, the GDK is based on Unity’s experimental [Entity Component System and Job System](https://unity3d.com/unity/features/job-system-ECS).
3231

@@ -54,14 +53,16 @@ Visit the **feedback** section in our [forums](https://forums.improbable.io) and
5453
Create an issue [in this repository](https://github.com/spatialos/UnityGDK/issues).
5554

5655
## Support policy
56+
5757
We are not supporting the alpha release for game development, as this version is for evaluation only. However, please do give us your feedback.
5858

5959
## Migration from the SpatialOS Unity SDK
60+
6061
Currently the GDK is in its early development, so there is no migration path from the [SpatialOS SDK for Unity](https://github.com/spatialos/UnitySDK) to the GDK. There will be a migration path in later releases.
6162

6263
---
6364
* Version: alpha (for evaluation only)
64-
* Unity Game Development Kit repository: [github.com/spatialos/UnityGDK](https://github.com/spatialos/UnityGDK)
65+
* Unity Game Development Kit repository: [github.com/spatialos/gdk-for-unity](https://github.com/spatialos/UnityGDK)
6566
* Use of the contents of this repository is subject to the [Improbable license](LICENSE.md)
6667
* Your access to and use of the Unity Engine is governed by the Unity Engine End User License Agreement. Please ensure that you have agreed to those terms before you access or use the Unity Engine.
6768

docs/contributions/unity-gdk-coding-standards.md renamed to coding-standards.md

Lines changed: 10 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,18 @@
1-
**Contributions**: We are not currently taking public contributions - see our [contributions](../../.github/CONTRIBUTING.md) policy. However, we are accepting issues and we do want your [feedback](../../README.md#give-us-feedback).
2-
3-
-------
4-
51
# SpatialOS GDK for Unity C# coding standards
62

7-
![Header Image](../assets/unity-gdk-header-cartoon.png)
8-
9-
_[© 2018 xkcd](https://xkcd.com/license.html)_
10-
11-
**Contributions**: We are not currently taking public contributions - see our [contributions](../../README.md#contributions) policy. However, we are accepting issues and we do want your [feedback](../../README.md#give-us-feedback).
3+
**Contributions**: We are not currently taking public contributions - see our [contributions](README.md#contributions) policy. However, we are accepting issues and we do want your [feedback](README.md#give-us-feedback).
124

135
## Table of contents
146

15-
- SpatialOS GDK for Unity C# coding standards
16-
- [Table of contents](#table-of-contents)
17-
- [Introduction](#introduction)
18-
- [ReSharper and formatting](#resharper-and-formatting)
19-
- [General](#general)
20-
- [Casing](#casing)
21-
- [Deprecation](#deprecation)
22-
- [Tests](#tests)
23-
- [Unity specific](#unity-specific)
7+
* SpatialOS GDK for Unity C# coding standards
8+
* [Table of contents](#table-of-contents)
9+
* [Introduction](#introduction)
10+
* [ReSharper and formatting](#resharper-and-formatting)
11+
* [General](#general)
12+
* [Casing](#casing)
13+
* [Deprecation](#deprecation)
14+
* [Tests](#tests)
15+
* [Unity specific](#unity-specific)
2416

2517
## Introduction
2618

docs/README.md

Lines changed: 0 additions & 69 deletions
This file was deleted.

docs/assets/UnityGDK-structure.png

-124 KB
Binary file not shown.
-4.71 MB
Binary file not shown.
-22 MB
Binary file not shown.
-149 KB
Binary file not shown.

docs/assets/update-order.png

-26.8 KB
Binary file not shown.

docs/assets/warning.png

-33.7 KB
Binary file not shown.

0 commit comments

Comments
 (0)