Switch to MkDocs for documentation #1334
Conversation
β¦ll mod it to make it look like .net
β¦o feature/mkdocs
β¦o feature/mkdocs
@lisaross Thanks for the visual fixes in c4bae26, it's much better now. I've also merged in This evening, I should find some time to look at this PR again, work on the smaller remaining issues and hopefully get it prepared for merge. |
Nice! I have to fix up the footer today and I think thatβll be a good commit to merge. Stay tuned :) if thereβs anything else I can do please let me know. Iβm super excited to have been able to help!
|
Gah! I just merged something into master without meaning to I think... please rewind if needed, @borekb Edit: oh good. I think I just gave myself an unneeded heart attack LMAO |
Yeah, everything is alright :) Actually, GitHub would prevent any accidental push to |
Ya I realized that after I typed. Of course you wouldn't let someone with a single pull request push to master lmao. That last commit was just adding your socnets to the footer - I was going to mod the whole footer file to make it look like .net, but realized that was probably enough and kept it simple. If you want me to make further mods just make me a list and I'll work on it tomorrow. Otherwise, I think the styling is ok for now? Or did I miss something? |
Yep, I actually like the current footer very much β keeps the style of previous docs but is more useful / modern.
Generally, I think it looks awesome, just the contrast of the search box is sometimes not great, e.g., on hover. Do you want to look into that? I could also experiment with it a bit. |
I'm looking at the styles, for example, setting the |
I've done some slight visual fixes in 070f528, I'm happy with it now. Still to-do (plan to do this tonight): |
β¦vicon (Material theme doesn't support it seamlessly so there is a template customization in main.html)
β¦, e.g., in release notes
β¦nverting * to - and other similar changes
Hi @lisaross, sorry for the delay, I think I'll find time today evening to have a look at the GitHub Pages deployment (just document the manual process in README) and then I'd be happy to merge this PR. Is that fine with you? Anything else you would like to look at? Thanks. |
oh my goodness, don't apologize! |
Thanks. I'll probably write a quick blog post about the new docs and would like to credit you, do you have a Twitter profile or something that you'd prefer me to use? Your contribution has been awesome! |
WOW! THANKS! My twitter profile is @iamlisaross but I've updated my github profile to display info instead if that's easier/better. |
I'll make some final notes in this PR later tonight and merge. |
Resolves #1332
(I think)
Lots of files and configurations changed but I've done my best to document how and what was done.
Some highlights:
Still to do
Some notes
@borekbπ notes:
This is an awesome PR and a nice refresh of our docs, thanks @lisaross! Highlights from my point of view are:
New site:
Original site: