-
Notifications
You must be signed in to change notification settings - Fork 98
Reorganize Halite Documentation #306
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
Conversation
|
This isn't ready yet, only a few pages have been converted, but I wanted to get some feedback on the approach. |
|
Why make a different .php file for every page of the reference? Why not just use a .htaccess file and one .php file for all of the reference pages. We could just check the filename of the url and then load the appropriate md file inside of the HTML/CSS boilerplate. |
|
This is like what we do with our API endpoints. See: https://github.com/HaliteChallenge/Halite/blob/master/website/api/web/.htaccess |
|
Sure, that sounds great. I'll figure out how to make that work. |
Reorganize how Halite is documented and switch from using HTML to using Markdown.
c65a21a to
ccb23bb
Compare
|
We might want to switch to a sidebar menu like bootstrap's or vuejs's (scrolls as you scroll, active menu item changes as you scroll), since the pages are so long. The alternative would be breaking up the long pages [tutorials page will get long since we would add the ml tutorial and your tutorial (if it's ok to move it from the forums)]. |
|
Also we will probably want to switch to styling that better differentiates html header tags. |
|
@Sydriax and I will make passes through the docs this weekend. I'll add in the .htaccess php trick. We hope to merge by Monday. |
|
Are any of the existing pages not converted? |
|
Moved to this PR #321. @nmalaguti to make changes, just PR into that branch. |
Reorganize how Halite is documented and switch from using HTML to using
Markdown.