Cesium: Scrub github wiki

Created on 8 May 2014  路  14Comments  路  Source: CesiumGS/cesium

category - doc onramping

Most helpful comment

Hi @zwcloud, we don't have this new tutorial yet, but we've definitely noticed a lot of people asking for more documentation regrading this. We have plans to create one within the next month or so, so keep an eye out.

All 14 comments

Areas most in need of updates:

  • [ ] [Architecture](https://github.com/AnalyticalGraphicsInc/cesium/wiki/Architecture)
  • [ ] [CZML in Cesium](https://github.com/AnalyticalGraphicsInc/cesium/wiki/CZML-in-Cesium)
  • [ ] [Creating Custom Geometry and Appearances](https://github.com/AnalyticalGraphicsInc/cesium/wiki/Geometry-and-Appearances) (future tutorial)
  • [x] [JavaScript Coding Conventions](https://github.com/AnalyticalGraphicsInc/cesium/wiki/JavaScript-Coding-Conventions)- should be pretty concise and point to actual code examples
  • [x] [Documentation Best Practices ](https://github.com/AnalyticalGraphicsInc/cesium/wiki/Documentation-Best-Practices) - should just point to a few representative examples in Cesium

Pushing.

@pjcozzi, in looking to spin up on changes since the late beta days (b28 / 30 or so), I turned to the developers wiki, and noticed the out of date comment and this issue:

This is now out-of-date. There will be a new version as part of #1683.

Should I be ignoring the whole page, or just taking it all with the understanding that some bits have shifted concerns, etc.? What's the status of the new page? Thanks!

A lot has changed since the beta. The wiki is still out of date. See http://cesiumjs.org/tutorials.html

Also, see the blog post for each release for the highlights. See CHANGES.md for all the details.

Regarding Coding Conventions:

  1. Coding conventions for GLSL shaders are missing. Currently used style is not consistent with used JS style (e.g. curly brace in JS always on the same line as preceding expression, but in GLSL opening curly brace after main() usually on separate line, and after if () from time to time on same line, or on next line).
  2. Coding convention says nothing about trailing spaces. @pjcozzi said in #3029, that they are forbidden, but this is not constrained anywhere (I think jshint should check them).

@rutsky you may be interested in #3312.

Thanks, @pjcozzi, I see that #3312 covers mentioned by me issues.

So... where is Creating Custom Geometry and Appearances (__future__ tutorial) after 3 years?

Hi @zwcloud, we don't have this new tutorial yet, but we've definitely noticed a lot of people asking for more documentation regrading this. We have plans to create one within the next month or so, so keep an eye out.

@zwcloud the content of this tutorial is mostly still accurate, just some of the code examples need to be updated https://github.com/AnalyticalGraphicsInc/cesium/wiki/Geometry-and-Appearances

Actually I have already created one myself by guessing and digging into the source code of Cesium. See this gist.

a related discussion in the forum

@ggetz @hpinkos

We have plans to create one within the next month or so, so keep an eye out.

It is about __Two__ months later, where is the new tutorial?

Hi @zwcloud, the Cesium team has a lot of projects going on right now, and plans can change fast.

It's good to hear your excited for the tutorial, maybe you could help by researching and contributing some content yourself?

Was this page helpful?
0 / 5 - 0 ratings