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

Evaluate AsciiBinder for publishing multiple versions of user manual and other docs #519

Closed
mojavelinux opened this issue Feb 28, 2016 · 2 comments

Comments

@mojavelinux
Copy link
Member

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.

@danyill
Copy link
Contributor

danyill commented Oct 7, 2017

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:

image

  • what I like even better is the way git-scm shows changes in the document

image

It would be cool to get the best of both worlds

  1. contextually aware version control integration as shown in the git-scm example, perhaps on a per chapter or section level
  2. 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.

@mojavelinux
Copy link
Member Author

We've decided to use Antora to accomplish this goal.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants