Remove redundant content #494
Conversation
morgane
requested review from
MiroMuse,
abhishektrip,
apavani,
brnkhy,
jordy-isaac and
wilhelmberg
There was a problem hiding this comment.
I'm ok with stripping down this documentation to the bare minimum needed.
But I think each remaining page should have a link to https://www.mapbox.com/unity-sdk/
Not just the Getting Started page.
The information about HoloLens - especially the sqlite part is super import, otherwise you won't get your project to even compile.
Therefore it would be great if the info about sqlite could live in both places.
|
@BergWerkGIS Thanks for calling that out! I've re-included the pages about HoloLens and added more links to /unity-sdk 👍 |
| ## Installation from Git (source) | ||
|
|
||
| 1. `git clone https://github.com/mapbox/mapbox-unity-sdk.git` | ||
| 2. [Read about how the project is configured](https://github.com/mapbox/mapbox-unity-sdk/blob/develop/README.md) and [learn how to contribute](https://github.com/mapbox/mapbox-unity-sdk/blob/develop/CONTRIBUTING.md) |
There was a problem hiding this comment.
IMO, there should be instructions to run the update script here instead of sending the user to the Readme
There was a problem hiding this comment.
What's the update script? I'm not sure I've used it before.
By the way, the rationale for removing some of this installation content is because we already have instructions at /unity-sdk. Should we update those instructions to mention this script?
There was a problem hiding this comment.
This is the script I am talking about update-mapbox-unity-sdk-core , instructions are here https://github.com/mapbox/mapbox-unity-sdk/blob/develop/README.md#from-this-repository-advanced-latest-development
This script is required to fetch the dependencies for the SDK. Without running the scripts the SDK will not work.
The instructions on the /unity-sdk page are about getting the package & released versions of the SDK. If someone is cloning the repo - these instructions would be handy. I don't mind having a duplicate of just Installation from Git in both places.
There was a problem hiding this comment.
Ohh got it got it. That's a good idea! I'll update the link.
|
I am totally for not having duplicate/redundant documentation. This is awesome. |
|
Thank you for the feedback y'all! I'm going to talk to @jfurrow about handling redirects for all the removed pages, to make sure we don't end up with broken links. Once we have a good plan for that, I'll merge this. |
…ing-experiments * commit '0ceb39815363646170bd8bc2e54c1ca64d45fb47': MBTilesCache: Windows fix for path and filenames with +260 chars fix Unity's bytecode stripping with IL2CPP discarding "ystem.Linq.Expressions.Expression" Auto refreshing cache (#521) Editor layer key fix (#506) Create PRODUCT_ROADMAP.md change MapId to Style URL in Map Image Editor (#536) Zoomable map scaling fix (#527) Add EditorConfig to enforce coding style (#508) [publish docs] [publish-docs] Remove redundant content (#494) Adding some clarification for inline documentation. Magnifier icon fix (#497) PreBuild script fix for Unity >= 2018.1 Fix MapMatching and Decompression tests (#504) # Conflicts: # sdkproject/Assets/Mapbox/Unity/Map/QuadTreeTileProvider.cs
3 participants
A lot of this content will exist on this page, or it already does!
I'm removing it in an effort to centralize where tutorials, technical narratives, and guides exist. All information about the API, changelog, and known issues will stay here.
If anything else absolutely needs to stay here, let me know!
More detail
As part of the process of submitting this PR, please: