Skip to content

Conversation

nmalaguti
Copy link
Contributor

Reorganize how Halite is documented and switch from using HTML to using
Markdown.

@nmalaguti
Copy link
Contributor Author

This isn't ready yet, only a few pages have been converted, but I wanted to get some feedback on the approach.

@truell20
Copy link
Contributor

truell20 commented Dec 4, 2016

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.

@truell20
Copy link
Contributor

truell20 commented Dec 4, 2016

@nmalaguti
Copy link
Contributor Author

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.
@truell20
Copy link
Contributor

truell20 commented Dec 4, 2016

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)].

@truell20
Copy link
Contributor

truell20 commented Dec 4, 2016

Also we will probably want to switch to styling that better differentiates html header tags.

@truell20
Copy link
Contributor

@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.

@truell20
Copy link
Contributor

Are any of the existing pages not converted?

@truell20
Copy link
Contributor

Moved to this PR #321. @nmalaguti to make changes, just PR into that branch.

@truell20 truell20 closed this Dec 11, 2016
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