Skip to content

Structured documentation using GitHub Pages and MkDocs Material - #10

Open
sohnemann wants to merge 40 commits into
maxvfischer:mainfrom
sohnemann:main
Open

Structured documentation using GitHub Pages and MkDocs Material#10
sohnemann wants to merge 40 commits into
maxvfischer:mainfrom
sohnemann:main

Conversation

@sohnemann

Copy link
Copy Markdown

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

@maxvfischer

Copy link
Copy Markdown
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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants