Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs Overhaul #321

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open

Docs Overhaul #321

wants to merge 7 commits into from

Conversation

truell20
Copy link
Contributor

@truell20 truell20 commented Dec 11, 2016

Original author: @nmalaguti

List of Outstanding Points

  • New content
    • 3rd party library list article needs to be written.
    • Reference docs need to be converted to markdown
    • Add links to third party tutorials (machine learning tutorial, @nmalaguti's tutorial)
  • Thoughts on current content
    • Feel like the Game Overview doc is a bit intimidating (b/c of the length). Maybe put a quick overview of the rules somewhere.
    • Contents of the Bot Overview doc seems a bit arbitrary
  • Sidebar
    • HTML list of articles doesn't need to be hardcoded. Can be generated by php.
    • edit on github link should change to the markdown
    • Ordering of the sidebar should probably be change. Tutorials should probably come after or nearly after quickstart.
    • Sidebar should scroll with the page like boostrap's
  • .htaccess trick to reduce boilerplate

nmalaguti and others added 4 commits December 4, 2016 16:04
Reorganize how Halite is documented and switch from using HTML to using
Markdown.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants