Structured documentation using GitHub Pages and MkDocs Material - #10
Open
sohnemann wants to merge 40 commits into
Open
Structured documentation using GitHub Pages and MkDocs Material#10sohnemann wants to merge 40 commits into
sohnemann wants to merge 40 commits into
Conversation
Owner
|
Man, what fantastic work you've put into this!! Thank you so much for spending the time, really appreciate it! I'm swamped with work this week, but will try to start looking through your pull request this weekend! Will probably not be able to go through the whole thing and merge it, but will definitely start! Also glad that you enjoyed the build! Were there any parts of it that you felt lacked context, that could've been better explained? Also if you don't mind it would be cool to see some pictures of your build 😄 //Max |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Hi Max,
First things first, thank you very much for your detailed guide!
A friend and I have built our CNC using it and after a long hiatus, we finally "finished" it.
We still need to work out the software part, but it's physically finished. 😁
I saw the discussion in issue #4 and decided to set this up using GitHub pages and create this pull request.
If you'd like to have a look at the result, please see:
https://sohnemann.github.io/DIY-CNC-machine/
All you'd need to do to use this setup, only if you're interested of course, would be to create a GitHub Repository Secret containing a token that is allowed to write to the GitHub Pages branch.
Then you would just need to allow GitHub pages and it would be good to go.
I also added a .stl file (front_panel_electronic_box_small_alternative_design.stl) that I designed, as we struggled with the USB port.
As there was not much space in our small electronics box, the soldered USB connection came off a few times, so I decided to design a sturdier version using one of these:
https://www.aliexpress.com/item/4000843915852.html
I have not done anything else to the documentation except structuring it for MkDocs Material to work, so there could still be a few rough edges here and there.
Please let me know what you think. 😊
Cheers,
sohnemann