search

CesiumGS / cesium

An open-source JavaScript library for world-class 3D globes and maps :earth_americas:
https://cesium.com/cesiumjs/
Apache License 2.0
12.76k stars 3.46k forks source link

Scrub github wiki #1683

Open pjcozzi opened 10 years ago

pjcozzi commented 10 years ago

Areas most in need of updates:

pjcozzi commented 10 years ago

Pushing.

nmschulte-aviture commented 9 years ago

@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!

pjcozzi commented 9 years ago

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.

nmschulte-aviture commented 9 years ago

The Graphics Tech in Cesium blog posts have been very helpful; thank you!

http://cesiumjs.org/2015/05/26/Graphics-Tech-in-Cesium-Stack/ http://cesiumjs.org/2015/05/15/Graphics-Tech-in-Cesium-Architecture/ http://cesiumjs.org/2015/05/14/Graphics-Tech-in-Cesium/

rutsky commented 9 years ago

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).
pjcozzi commented 8 years ago

@rutsky you may be interested in #3312.

rutsky commented 8 years ago

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

zwcloud commented 6 years ago

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

ggetz commented 6 years ago

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.

hpinkos commented 6 years ago

@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

zwcloud commented 6 years ago

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

zwcloud commented 6 years ago

@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?

ggetz commented 6 years ago

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?

sanjeetsuhag commented 2 years ago

Revisiting this now, I parsed through the existing wiki and here's my recommendations for what to keep/move/remove:

Check into repository

To Review/Delete:

ggetz commented 2 years ago

Thanks @sanjeetsuhag! The Feature Checklist is import for potential customers evaluating CesiumJS and should definitely continue to live somewhere. At one point this was on the website, but could make sense in the Documentation directory.

Setting aside the outdated roadmaps, there is a good deal of information here. Would you recommend any of these can be updated and become a blog post or tutorial instead? For example Architecture (in the same vein as the Renderer Architecture post?

sanjeetsuhag commented 2 years ago

@ggetz The existing architecture wiki page tackles the broader engine architecture and we could potentially write a blog about that - or check it into the repo and have it serve as a good on-ramping doc for new devs.

ggetz commented 2 years ago

Just to be clear here-- Feel free to leave ideas, but let's plan on holding off on deleting anything for now and only focus on what can be moved into the repo itself.