Commit Graph

2 Commits

Author SHA1 Message Date
James Hegedus
57c5e9dbcb
Significant documentation site improvements (#440)
# Summary

This contains fixes and significant improvements to the documentation site.

* fixes some routing issues due to erroneous docsify config
* fixed links and layout of 404 pg
* improved the language on the landing page as per #438 
* propose a NEW_README.md tackling concerns with #438  and #422 
* use docsify specific md to emphasise some text
* add docsify-themeable plugin to improve loading experience and future proof for customisation
* improve use of `asdf-vm` over `asdf`

## Other Information

Included in this PR is a file `docs/NEW_README.md` which is my proposed README for this repo. The intention was to have all documentation in a single place, the site, and simplify the readme bringing the focus to explaining the tool rather than instructing users on how to use it.

I will create a separate PR for the README, but in the meantime the landing page composes this new readme with the ballad.
2019-01-25 19:17:20 +11:00
James Hegedus
2fcde332ae Documentation site (#422)
* init docsify
* add config & plugins to support required features
* create cover page
* add sidebar headings
* add novel 404 page
* add translation message to 404
* add navbar with translations dropdown
* fix punctuation
* add all-plugins section pulling from asdf-plugins repo readme
* update sidebar with sections, better names & descriptions for contributors
* add changelog. pulls from repo
* add thanks page. credits, maintainers & link to contributors on github
* add core documentation
* rm old readme from docs/ folder
this was copied here on docsify init
* comment out some translation config
  ideally this will remain commented out serving as an example for any translation contributions
* run prettier over markdown
* add plugins-create section
* add contributing sections to the docs
* fix cover page get-started link
* use the readme as the main homepage
* update asdf version in docs with release script
2019-01-12 11:32:30 -05:00