When one goes to http://ruby.sketchup.com/ and clicks on ‘Files’ in the list pane, the list could easily contain several more items without needing to be scrolled.
Would Trimble allow ‘user created’ content to be placed there? Maybe the content could reside in a different repo, with all docs being markdown / .md format? Maintainers of the repo (commit rights) could be both Trimble staff and others.
I don’t know how much work it is updating the API site. Obviously, every commit to a docs repo would not justify regenerating the API site. Since GitHub renders md files well, one could always go to the repo for the most current info.
The kind of information I’m speaking is falls into two categories.
First, simple guides to things like Html and Web dialogs, maybe a description of event flow with tool plugins, maybe info about observer issues, etc.
Secondly, one or more reference doc’s with information about SU version and OS info.
Things like tables with Ruby version, HtmlDialog CEF version, browser versions used by WebDialog, JScript capabilities (arrow functions, etc).
Some (but not all) of this info is contained in the ‘Release Notes’, but it’s knd of a PITA to go thru it.
@thomthom - I assume this would probably get added to your responsibilities, so wadda ya think?
JFYI, if this was implemented tomorrow, I couldn’t work on it for a week or two.
Also, with YARD, the
.yardopts file can take absolute or relative paths for the docs list, so it can include docs/files from outside the normal code directory. I use it for many of the repos I doc that have separate ‘wiki’ repos…