search

silverstripe / silverstripe-docsviewer

Documentation generator that powers doc.silverstripe.org and your own projects
BSD 3-Clause "New" or "Revised" License
20 stars 23 forks source link

Create "edit" buttons for doc.silverstripe.org #15

Closed sminnee closed 12 years ago

sminnee commented 12 years ago

So, strictly speaking this will be a change for doc.silverstripe.org but I think that it would be best implemented as a module feature.

We have documentation, for example at: http://doc.silverstripe.org/framework/en/trunk/misc/contributing.md

There is already an edit link for this page at: https://github.com/silverstripe/sapphire/edit/3.0/docs/en/misc/contributing.md

I would like for us to have an "edit" button on our doc pages, pointing at this link. GitHub will take care of the rest.

wilr commented 12 years ago

I guess this will be more a doc.silverstripe.org template change than the module (not all modules would be editable) (although it would need the required API hook). I'll still take it on.

sminnee commented 12 years ago

Thanks, Will, much appreciated! :-)

wilr commented 12 years ago

Module hook: https://github.com/silverstripe/silverstripe-docsviewer/commit/3a9a384ca4eb1adaa5b5ceea9cc0e031e0c38243. Though I note ss2doc is still running an old version of docsviewer. That will need to be updated or this cherry picked into your pistonized version.