search

exokitxr / webmr-docs

Exokit documentation
https://docs.webmr.io
4 stars 2 forks source link

Major docs update #102

Closed chrislatorres closed 5 years ago

chrislatorres commented 5 years ago

This PR is to fill out, clean, and organize the docs.

chrislatorres commented 5 years ago

pushed to gh-pages, this is what the styling of landing page looks like:

screenshot from 2018-10-17 20-30-18

chrislatorres commented 5 years ago

Still planning on adding content for the guides and the missing images.

avaer commented 5 years ago

Is there a way to preview but not deploy until the PR goes in?

avaer commented 5 years ago

Those hero images look "good" but they don't really provide any insight into the link destination.

ChristopherTrimboli commented 5 years ago

I think its cool but yeah the pictures should be something more relevant, and I think the exogon section with title would look good above this, as the front page feels a bit small now.

example: cvbxcvb

ChristopherTrimboli commented 5 years ago

Ok one other thing, i was going into this branch to try and add the title section back with the Exogon... I would highly prefer if we commented things out and made new functions for a new section.

The nice thing about working in React, is that we can swap sections in and out as components, but now when i'm trying to merge the old stuff with the new PR, its painful, because the old functions are overwritten. I would have to go through manually and try and piece together the section again.

I would prefer if we just comment out whatever we are gonna change and make a new component. Makes it easier to swap stuff in and out. And we are also not deleting other people's work by doing modular component based coding.

ChristopherTrimboli commented 5 years ago

here is some examples of what i mean about overwriting old features...

this features function should just be left out of the render() or commented out, make a new component for what we are going to make and drop it into the render...

https://github.com/webmixedreality/webmr-docs/pull/102/files?utf8=%E2%9C%93&diff=unified#diff-cbcca24c9fdb811cd5d539d933af69fbL102

another: https://github.com/webmixedreality/webmr-docs/pull/102/files?utf8=%E2%9C%93&diff=unified#diff-cbcca24c9fdb811cd5d539d933af69fbR61

hope this makes sense, just pushing for modular additions to the code base instead of overwrites.

chrislatorres commented 5 years ago

Is there a way to preview but not deploy until the PR goes in?

I re-deployed from master for now. Will make a fork and do gh-pages from there to preview.

Those hero images look "good" but they don't really provide any insight into the link destination.

I agree, these were just used for as placeholders. Will work on more descriptive images.

this features function should just be left out of the render() or commented out, make a new component for what we are going to make and drop it into the render...

I agree, I will re-add what was deleted.

I think its cool but yeah the pictures should be something more relevant, and I think the exogon section with title would look good above this, as the front page feels a bit small now.

The reason for this style was for users to be able to click to approximately where they need to go in the docs right away from the landing page.

chrislatorres commented 5 years ago

What the new landing page style+imgs look like:

screenshot from 2018-10-18 14-18-22