xebia
Reference documentation
Do we have reference documentation?
I just checked the source code to find out the proper syntax for 'save screenshot after', there must be a better way :)
There is Javadoc generated (it's in maven). Indeed it would be nice to have an on-line reference with small, working examples.
The pages at ProjectXebium in the embedded FitNesseRoot are already quite good.
Most people will not have the project checked out and 'mvn -Pfitnesse test' running though. Might be interesting to have (generate) a static read-only version of those pages, so we don't need to look for hosting for an actual running instance.
The current pages are mostly tutorial-esque, a reference section next to that would make sense.
I took a stab at this, pushed my current progress into the 'organizedocs' branch.
Could you review this? Next I think I'd like to:
- rename the 'Example 0XX' tests
- move examples 001-005 to under 'AnIntroduction' (as they introduce concepts that might be useful to understand the other pages)
- move examples 008-009 to under 'Poweruser Configuration' (as those do not describe day-to-day usage)
Thoughts?
Sure, though I really like keeping this as an 'executable document'.
Perhaps we could export a nicely formatted static/readonly version of the ProjectXebium suite to gh-pages somehow?
Sounds like a plan ;) Op 27 feb. 2013 17:43 schreef "Arnout Engelen" [email protected] het volgende:
Sure, though I really like keeping this as an 'executable document'.
Perhaps we could export a nicely formatted static/readonly version of the ProjectXebium suite to gh-pages somehow?
— Reply to this email directly or view it on GitHubhttps://github.com/xebia/Xebium/issues/73#issuecomment-14184193 .
OK, I'm fairly happy with the structure now, next step is generating gh-pages.