Create a Docs Repository

Summary

We’re currently in progress of transforming the existing wiki into a Jekyll / Github Pages based docs repository. This issue acts as an overview issue until the first release has taken place.

Progress

The basic setup is still in progress and there are a lot of issues to pick up for contributors. You’ll find all required issues for a first release in this milestone. Contributions work via fork and Pull Request in the same way they do in this repository.

---

Original issue text:

Summary

As discussed in issue #355, we should consider moving away from the GitHub Wiki for documentation in the long term. One alternative would be to create a new AdamsLair/duality-docs repo that hosts all documentation.

Analysis

• The GitHub Wiki lacks some features and also has some disadvantages from the management side:
  • Pages need to have unique names and folder structures are ignored.
  • Users can’t upload images and other media.
  • Lack of multi-version support (crucial for v3.0).
  • Lack of multi-language support.
  • No branches for bigger edits, no PRs or reviews.
  • Either everyone can edit, or only people with direct push access.
  • History not available on a global level.
• All of these problems are solved by moving docs to a new AdamsLair/duality-docs repository.
• The repository’s main readme file acts as the home page for documentation.
• A proper directory structure needs to be defined.
  • Anticipate support for multiple versions co-existing.
  • Anticipate support for multiple languages co-existing.
  • Maybe something like Pages/en/vX/...?
• Investigate the possibility of turning on the github pages feature for the master branch and generating a nice docs website from the markdown files.

This issue is up for grabs. Let me know if you’re interested in getting some work done on this. Ideally, do the first prototypes in a public repo in your own account, which we can later either transfer or re-create in the AdamsLair organization.

[ilexp]

I’ll be off for a week, but will get back to you as soon as I’m back 👍

[BobGneu]

The template can be modified. I can look into that if you would like.