devgianlu / PYX-Reloaded

A fork of the original Pretend You're Xyzzy, with a completely rewritten frontend and some major changes on the backend
Apache License 2.0
26 stars 13 forks source link

Set Up This Repo's GitHub Pages From "gh-pages" Branch In Repo's Settings #39

Closed HopperMCS closed 6 years ago

HopperMCS commented 6 years ago

@devgianlu,

I've created a branch and added mdBook documentation files. Could you please set the GitHub Pages to use this branch as the content source? In the settings, it should be enabled in the directions at: https://github.com/blog/2228-simpler-github-pages-publishing

screenshot from 2018-01-27 21-35-56

THIS BRANCH SHOULD NEVER BE MERGED WITH DEVELOPMENT BRANCHES. IT IS AN ORPHAN AND WILL DELETE EVERYTHING IN THEM.

This will give the docs for the project much more structure, plus it will be sexy as hell on both laptops and phones (this is the same tool most Rust projects use to generate their docs, #dope). Also we can redirect users here from the README for setup instructions. Note that this should redirect to the URL https://devgianlu.github.io/PYX-Reloaded.

HOWEVER, ONLY YOU HAVE PERMISSION TO CHANGE REPO SETTINGS, WHICH EXPLAINS THE ASSIGNMENT AND LABEL OF THIS TICKET.

HopperMCS commented 6 years ago

screenshot from 2018-01-27 23-16-08