You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Right now, we have a single version of the (rather lengthy) user manual. While this was an essential first step to getting the docs effort started, it's time that we start working towards a more mature documentation architecture. One of the key requirements is publishing a version of the user manual per release of the software (however we decide to define release in this ecosystem).
One tool we should evaluate is AsciiBinder. AsciiBinder was designed in particular to solve the problem of publishing multiple versions of multiple documents on a single static site. We may decide to use AsciiBinder, or we may decide to implement the same design within Awestruct or Middleman. Either way, we want to build on the work already done.
That would be cool. Asciibinder looks interesting.
A couple of other nice UIs:
readthedocs which has a little js callout in the lower right with:
what I like even better is the way git-scm shows changes in the document
It would be cool to get the best of both worlds
contextually aware version control integration as shown in the git-scm example, perhaps on a per chapter or section level
easy linkages to source and output in different formats (pdf, ebook, html) and a good search window as per readthedocs
Finally what neither of these do that I would also like to see would be the ability to click "Previous version diff" or similar and get a highlight of the changes to the previous version.
Right now, we have a single version of the (rather lengthy) user manual. While this was an essential first step to getting the docs effort started, it's time that we start working towards a more mature documentation architecture. One of the key requirements is publishing a version of the user manual per release of the software (however we decide to define release in this ecosystem).
One tool we should evaluate is AsciiBinder. AsciiBinder was designed in particular to solve the problem of publishing multiple versions of multiple documents on a single static site. We may decide to use AsciiBinder, or we may decide to implement the same design within Awestruct or Middleman. Either way, we want to build on the work already done.
This is related to #366.
The text was updated successfully, but these errors were encountered: