Skip to content

Documentation landing page update#36

Merged
david-rhodes merged 6 commits intodevelopfrom
getting-started-landing-page
May 1, 2017
Merged

Documentation landing page update#36
david-rhodes merged 6 commits intodevelopfrom
getting-started-landing-page

Conversation

@david-rhodes
Copy link
Copy Markdown

  • Polish, organization, and more information.

…tains more useful information.

Polished the content a bit.
@david-rhodes david-rhodes requested a review from isiyu April 27, 2017 20:12
@david-rhodes david-rhodes changed the title Documentation anding page update Documentation landing page update Apr 27, 2017
@david-rhodes
Copy link
Copy Markdown
Author

I feel we should add more information about what the SDK is and what you can build with it.

@isiyu
Copy link
Copy Markdown

isiyu commented Apr 27, 2017

Is the goal to keep the documentation home page and the index landing page always in sync? It seems redundant and possibly confusing to have the landing page be the front page of the "documentation" section. I see options:
1 - have https://www.mapbox.com/mapbox-unity-sdk/ start on the 'Documentation` homepage; so we won't need
2 - have a more broad index.html that just says "welcome to mapbox unity sdk"

I feel we should add more information about what the SDK is and what you can build with it.

I think step by step narrative guides on how to recreate each of the examples would go a long way here. Or were you thinking links to blog posts?

@david-rhodes
Copy link
Copy Markdown
Author

david-rhodes commented Apr 27, 2017

In my mind, the index should be quite polished and informative. I think we can strip out the redundant getting started link. I kept it in for now because I think we linked some people there already and didn't want to send them to a broken link. Maybe we can deprecate next publish?

For extra information in the index, I was thinking of more general stuff--key features, potential use-cases, etc.

@david-rhodes
Copy link
Copy Markdown
Author

@BergWerkGIS is there any way we can get the table of contents to show for the index page?

- new landing page
- added custom css template
- updated mapbox logo/favicon
@isiyu
Copy link
Copy Markdown

isiyu commented Apr 29, 2017

  • did a pass at the landing page, borrowed heavily from DocFX's landing page
  • updated Mapbox logo/favicon
  • added a blog widget, not sure how helpful that is

@david-rhodes this may be a different direction from what you had in mind.
In writing this comment, i looked at the Unity docs and see what you're saying. I think in the long run once we have a more robust Manual section with tutorials, we should just have the landing page be the Manual/Tutorial and guides section. @BergWerkGIS is it possible to have the index.html land on the written docs home page

This is what the landing page should look like:
screen shot 2017-04-28 at 5 05 43 pm

@isiyu
Copy link
Copy Markdown

isiyu commented May 1, 2017

replaced the blogs widget with the original getting landing page info.

dochome

@wilhelmberg
Copy link
Copy Markdown

@BergWerkGIS is it possible to have the index.html land on the written docs home page

@isiyu you mean get the contents of 00-getting-started.md to display directly at https://www.mapbox.com/mapbox-unity-sdk/ ?

Haven't tested, but I think this would be the place to reference it:

{ //put docs/index.md into _site root as start page

@david-rhodes
Copy link
Copy Markdown
Author

replaced the blogs widget with the original getting landing page info.

Did you push? I don't see this when building locally.

@isiyu
Copy link
Copy Markdown

isiyu commented May 1, 2017

@david-rhodes sorry! just pushed!

@david-rhodes david-rhodes self-assigned this May 1, 2017
@david-rhodes david-rhodes merged commit 1f43ce5 into develop May 1, 2017
@david-rhodes david-rhodes deleted the getting-started-landing-page branch May 1, 2017 18:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants