AsciiDocsy Release History

This page was generated by ReleaseHX, a component of AsciiDocsy. ReleaseHX is fully open source, and you are welcome to use it in your project.

This page tells the story of AsciiDocsy. This system for Release Notes and Changelog is itself novel and experimental. It is intended for collaborative team implementation at scale, which we try to demonstrate here as we scale up to the complexity of the v1.0 release.

Version 0.3.0, 2021-09-21

The third minor release of AsciiDocsy refactors the entire theme as a proper Ruby gem! Now you can modify and extend AsciiDocsy while staying in-sync with the upstream releases. There is some disruption involved — see Upgrading to 0.3.0 for full details.

The following flag appears in this release.

Breaking

Changelog

Improved

Repackaged theme as Ruby gem

Converted styles to Sass

Moved docs-site definitions to separate repo

Release Notes for v0.3.0

Layout/styles changes in v0.3.0

No special notes for Layout/Styles changes in this release.

Content management changes in v0.3.0

No special notes for Content Management changes in this release.

Back-end changes in v0.3.0

Repackaged theme as Ruby gem

AsciiDocsy can now be installed as a gem. Add it to your Gemfile under :jekyll_plugins and indicate the theme in the site.theme parameter. See the docs for details.

docs

Upgrading to AsciiDocsy 0.3.0

tags

Breaking

ticket

Issue #31

commit

70d37a3

Converted styles to Sass

All Bootstrap and AsciiDocsy CSS is now sourced as Sass under the _sass/ path.

docs

Extending the Theme

tags

Breaking

ticket

Issue #24

commit

1c65563

Documentation changes in v0.3.0

Moved docs-site definitions to separate repo

While the source of AsciiDocsy technical documentation remains in the AsciiDocsy theme repo under _docs/, and the attributes-data source has moved to lib/asciidocsy/data/, the files that configure the AsciiDocsy documentation deployment have moved to a distinct repo.

This move was mainly to model a proper docs-as-code deployment chain for the AsciiDocsy docs themselves. The AsciiDocsy theme repository is treated as a Git submodule of that documentation repo, so the docs repo always has ready access to the documentation and data directories of the subject repo.

Version 0.2.1, 2021-08-22

Front-end cleanup and dropping the .html.

The following flag appears in this release.

Deprecation

Changelog

Improved

Stopped Asciidoctor from appending .html to xrefs

Fixed

Added the obligitory Algolia logo to search forms

Stopped the top navbar from scrolling at mobile widths

Removed Iconic from skins selection list

Eliminated scrolling of right sidebar in shorter browsers

Added optional labels, icons to button-based handlers

Fixed ticket-link template rendering in ReleaseHx

Fixed Docs link feature in Changelog entries

Release Notes for v0.2.1

Layout/styles changes in v0.2.1

Removed Iconic from skins selection list

Because the Iconic skin imposed an ugly box under the page header that was not obviously fixable, Iconic will no longer be an option for users to select in the AsciiDocsy demo site skin changer. The Iconic skin source itself may be removed as early as v0.3.0. Mostly this note was just an excuse to use the deprecation tag, also added in this release.

tags

Deprecation

ticket

Issue #13

commit

3b7510c

Fixed Docs link feature in Changelog entries

Changelog entries with one and only one doc link will now hyperlink directly to that doc URL. Those with 2 or more doc entries still link to the Release Note entry for the same change, but now all changes with 2+ doc entries will always appear under Release Notes, even if they have no note property, so their multiple docs links can appear.

commit

f4346d5

Content management changes in v0.2.1

No special notes for Content Management changes in this release.

Back-end changes in v0.2.1

No special notes for Back-end changes in this release.

Documentation changes in v0.2.1

No special notes for Documentation changes in this release.

Version 0.2.0, 2021-07-21

This release introduces a suite of version-handling features as well as a new theme configuration system and experimental ReleaseHx templates. Several bugfixes are also included.

The following flags appear in this release.

Breaking Experimental

Changelog

Added

Added version-handling features and config system

Added ReleaseHx “release history” templates

Started reporting Release History for AsciiDocsy

Improved

Refactored the theme config system, moving from site scope to site.data scope

Fixed

Started tracking Gemfile.lock in Git (removed from .gitignore)

Fixed “peel” (“print-friendly”) function/page-link

Widened footer, removed unwanted margins

Fix handling of site.base_url in head hrefs

Release Notes for v0.2.0

Layout/styles changes in v0.2.0

No special notes for Layout/Styles changes in this release.

Content management changes in v0.2.0

Added version-handling features and config system

A full suite of versioning options now enables amending the DOM, swapping tokens, toggling classes, and tabbing panes. Also resolves Issue #9.

docs

configuration reference

tags

Breaking

ticket

Issue #10

commit

62bf5dd

Added ReleaseHx “release history” templates

AsciiDocsy provides a templates and a YAML format for generating release notes and/or a changelog. If you are reading this as HTML or PDF, you are most likely looking at one such generated release history, for AsciiDocsy itself. Documentation is forthcoming; this feature may change without notice prior to 1.0.

tags

Experimental

commit

428a4eb

Back-end changes in v0.2.0

Refactored the theme config system, moving from site scope to site.data scope

A full suite of versioning options now enables amending the DOM, swapping tokens, toggling classes, and tabbing panes.

Documentation changes in v0.2.0

Started reporting Release History for AsciiDocsy

The flagship implementation of the ReleaseHx minimum-viable product is the AsciiDocsy Release Notes and Changelog itself.

docs

Release History

commit

8d7ab51

Version 0.1.1, 2021-05-26

A few promised fixes, nothing backward incompatible.

Changelog

Improved

Improved the install instructions with basic Netlify deployment option

Fixed

Split search into 2 indices as was already indicated in UI

Fixed Navgoco (subject) menu highlights

Fixed semantic term icon spin feature

Release Notes for v0.1.1

Layout/styles changes in v0.1.1

No special notes for Layout/Styles changes in this release.

Content management changes in v0.1.1

No special notes for Content Management changes in this release.

Back-end changes in v0.1.1

Split search into 2 indices as was already indicated in UI

Both searches were drawing off the same index, so we switched them up into site search and subject search.

commit

f0a3071

Documentation changes in v0.1.1

No special notes for Documentation changes in this release.

Version 0.1.0, 2021-05-19

This first release of AsciiDocsy has a long way to go, but it is already more mature than many Jekyll docs themes.

Changelog

Added

Added initial back-end and front-end infrastructure.

Added initial technical documentation.

Release Notes for v0.1.0

Layout/styles changes in v0.1.0

No special notes for Layout/Styles changes in this release.

Content management changes in v0.1.0

No special notes for Content Management changes in this release.

Back-end changes in v0.1.0

No special notes for Back-end changes in this release.

Documentation changes in v0.1.0

Added initial technical documentation.

Basic documentation site uses AsciiDocsy theme under _docs/ directory. Also introduces rudimentary Config API reference platform/DSL.