Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CHANGES.md links #331

Closed
pjcozzi opened this issue Nov 15, 2012 · 4 comments
Closed

CHANGES.md links #331

pjcozzi opened this issue Nov 15, 2012 · 4 comments
Labels
category - doc cleanup good first issue An opportunity for first time contributors

Comments

@pjcozzi
Copy link
Contributor

pjcozzi commented Nov 15, 2012

Cesium types in CHANGES.md should link to the reference doc.

Likewise, mention of new Sandcastle demos should link to them.

I'm not sure how to keep the website in sync yet. Perhaps we just allow links in CHANGES.md to be broken in master until we do the monthly release. We'd update the website as part of the release - which should not stop us from updating it more often.

@pratnala
Copy link

Hi Patrick, can I get some help on this issue? Like, how to get started etc?

@pjcozzi
Copy link
Contributor Author

pjcozzi commented Apr 30, 2013

For this we would modify the markdown in CHANGES.md to link Cesium types to their reference documentation, instead of just showing them as code. For example, we would change:

Fixed `EllipsoidPrimitive` picking and picking objects with materials that have transparent parts.

to

Fixed [EllipsoidPrimitive](http://cesium.agi.com/Cesium/Build/Documentation/EllipsoidPrimitive.html) picking and picking objects with materials that have transparent parts.

which changes:

Fixed EllipsoidPrimitive picking and picking objects with materials that have transparent parts.

to

Fixed EllipsoidPrimitive picking and picking objects with materials that have transparent parts.

You might be able to write a script to do this, but you would have to verify everything since sometimes we remove or rename a type. Also, for new types, the reference doc will not exist yet, but it is easy to predict the url, which will be live when Cesium is released at the start of each month.

@mramato
Copy link
Contributor

mramato commented Jul 25, 2014

Are we every actually going to do this? I vote we just close this issue. Linking to new Sandcastle examples is a good idea; but that could be added to the release process for 1.0 going forward.

@pjcozzi
Copy link
Contributor Author

pjcozzi commented Jul 25, 2014

Agreed.

@pjcozzi pjcozzi closed this as completed Jul 25, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
category - doc cleanup good first issue An opportunity for first time contributors
Projects
None yet
Development

No branches or pull requests

3 participants