Checka11y.css icon indicating copy to clipboard operation
Checka11y.css copied to clipboard

[DOCUMENTATION]: Move the documentation website source code into the master branch

Open jackdomleo7 opened this issue 2 years ago • 2 comments

Documentation Issue or Feature

Describe the documentation issue or feature request

Currently, the documentation website source code is sitting in the gh-pages branch. I want to change this so it sits in a docs/ directory in the master branch, then automatically deploy to the gh-pages branch. I also want to utilise Nuxt 3 rather than raw HTML, CSS & JS.

Acceptance criteria

  • [ ] Use Nuxt 3
  • [ ] Move docs into master branch
  • [ ] Script to deploy to the gh-pages branch
  • [ ] Automatically deploy to gh-pages on every master build

Why is this important?

This is important because it keeps the code clean and in one place. It also allows other developers to easily contribute to the documentation website.

jackdomleo7 avatar Oct 14 '21 11:10 jackdomleo7

Blocked because this needs to ideally wait until contributions on the project die down (after Hacktoberfest) because this will/may encounter some big structural changes.

jackdomleo7 avatar Oct 14 '21 11:10 jackdomleo7

Blocked still due to waiting for static builds to be supported by Nuxt 3

jackdomleo7 avatar Oct 30 '21 17:10 jackdomleo7