Git Product home page Git Product logo

hifi-docs-grav-content's Introduction

High Fidelity: Documentation (Grav)

Content repository for hifi-docs on Grav

Grav is a modern open source flat-file content management system (CMS).

High Fidelity (hifi) is open-source software where you can create and share virtual reality (VR) experiences. You can create and host your own VR world, explore other worlds, meet and connect with other users, attend or host live VR events and much more.

The purpose of this repo is to be the canonical source of content for generating the High Fidelity documentation site: docs.highfidelity.com.

hifi-docs-grav-content's People

Contributors

alanzimmerman avatar alexiamandeville avatar anshuman64 avatar asbecker8 avatar atlante45 avatar birarda avatar chrislroy avatar dback2 avatar elmanytas avatar flamesoulis avatar huffman avatar hyperlogic avatar jennaingersoll avatar kevinfrutiger avatar lskyway18 avatar marko8904 avatar mikeperrotta avatar miladnazeri avatar misslivirose avatar nex-pro avatar nimisha20 avatar patcon avatar rebeccastankus avatar robinkwilson avatar sarah-duck avatar starphys avatar themelissabrown avatar thoys avatar whoaitsaimz avatar zfox23 avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

hifi-docs-grav-content's Issues

Use prose.io for friendlier github editing

Hi again!

I see that you currently link each page in https://doc.highfidelity.com to the github page in the grav content repo. This is awesome!

Having said that, I wonder whether prose.io might better serve you. It's an alternative to the github edit interface, designed by a well-respected web dev agency called "Development Seed". This company wanted to a build on GitHub Pages, but didn't want to force non-technical users to wade through coder lingo. Its a little less value-add these days, as github has done a whole lot to improve the PR creation workflow, but it's still nice.

Prose.io is technically a really thin GitHub Pages app itself, totally open source -- it just uses a really slim authentication proxy to coordinate the oauth dance with github, but is otherwise stateless and just runs off github api. And fwiw, "Development Seed" are the creators of "MapBox", and they're a stable force imho.

So instead of linking to GitHub's edit page, you'd just link here:
http://prose.io/#highfidelity/hifi-docs-grav-content/blob/master/01.get-started/01.what-is-high-fidelity/docs.md

or here maybe:
http://prose.io/#highfidelity/hifi-docs-grav-content/edit/master/01.get-started/01.what-is-high-fidelity/docs.md

This is how it looks when submitting (ie. absolutely no github once you login):
https://imgur.com/dVw9jfX

And here's the generated PR:
#191

02.material-guide is literally gobbledygook to most creators.

One of the largest hurdles I had as a creator in High Fidelity was figuring out the proper way to export material images to an FBX. The current documentation for this is at this github path:

hifi-docs-grav-content/02.create-and-explore/07.3d-modeling/01.materials/02.material-guide/docs.md

Information like, "Shininess = Hardness * 100 / 512" or "Opacity = 1 - average(Blender.Transparency.Alpha)" mean nothing at all to me. The documentation alludes to images of the Blender UI, which might clear things up, but these aren't actually present in the documentation.

What I need to know is simply which image maps correspond to which Blender Internal material settings. Instead, I see documentation better suited to someone writing an addon for Blender. Think creators and artists, not programmers.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.