-
-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Reworked Github Wiki #9370
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
Reworked Github Wiki #9370
Conversation
b979e09
to
e38ad6e
Compare
I hope to be able to give this a look in a couple of weeks or so! |
Hey this is great! I recently copied and cleaned up all the wiki content into markdown files here (https://github.com/ndom91/orcaslicer-docs) available as preview deploy here https://orcaslicer-docs.vercel.app/docs We've been talking about it in the discord here. I'm not necessarily married to using that docs framework but I'd love to get that version of the docs deployed and released officially. But maybe we can at least collaborate on the markdown content? Ive tried @-ing SoftFever there to move that repo under the Orcaslicer github org and try to get the Vercel deploy under the Orcaslicer domain, but haven't heard back from them yet. |
@ndom91 Thats great! I had searched for any relevant doc change or something like that in the Discord Server but didint gound this. That said, your approach, which depends on migrating to MKX, will always lag a bit behind updates made here, while PR #7497 MKDocs implementation only requires a bit of copy-pasting to stay in sync. Whichever path we choose, I’m more than happy to contribute to the transition. My goal is to help Orca become the go-to FDM slicer, which is why I try to integrate everything I’ve developed and make the tool accessible to as many users as possible. As for MKX: it's a bit of a mixed bag for me. I love MK, but I’m not a fan of JS. Still, I do find MKX to be an interesting and practical format for this kind of use case. To reiterate, if we decide to move forward with it, I’m here to help with updating the documentation. Even if the current content is a bit outdated, none of the work done so far is wasted, as it all serves as a solid foundation. |
e38ad6e
to
0d85ec1
Compare
Yeah so the way I'd like to see it is that we'd then only have 1 source of truth for the docs content. We would no longer have the wiki baked into the github repo. Only then the Regarding the md/mdx thing - I don't have a strong feeling here. I mean mdx is strictly a superset of normal markdown, right. So folks could just write their normal markdown content in the And to your last point - we can obviously then copy out any newly added content to wiki into whatever docs format / repo we end up going with when that time comes, so yeah no effort wasted there 🙏🥳 |
ac13e77
to
627d843
Compare
I'm on mobile and I cannot contribute, but I think that before the tolerance check (it's not really a calibration) a mention of the califlower scaling test should be made, so that prints are as accurate as possible by compensating shrinkage. |
The Orca Tolerance Test can be used with X-Y hole/contour compensation and it was already in the calibrations wiki. The Califlower Calibration Tool Mk2 its a paid and register tool and i want to be away from it. |
FYI: There is also an open source alternative called the Calistar: https://github.com/dirtdigger/fleur_de_cali |
It looks good, i will give it a try becouse i was thinking to add a Skew calibration too.
If nothing is changed or updated upon my return, it is possible that some development will go to the discord, so those who want to participate stay tuned there. |
616793e
to
33d7163
Compare
33d7163
to
9683ad8
Compare
I'm checking it out. https://orcaslicer-docs.vercel.app/docs/adaptive-pressure-advance should mention my remark from #9610 which is that adaptive PA does not strictly require the full matrix of acceleration and speeds, the user can manually remove test patterns and leave only those which correspond to actually useful combinations or ranges. Typically, the acceleration for inner, outer perimeters and top surface should be optimised for a range of speeds, since the layers can be slowed down. Proposal: after Speed – Acceleration ... (table follows)"
This reduces the number of test patterns to 1+2x3 = 7 patterns, or 10 if the acceleration for the top surface is also included." The PA step of 0.001 is excessive, it becomes difficult to pick between lines. It's basically always sufficient to use 0.0025 and then, upon need, just interpolate in between. Since the Wiki is for the average user, not for special cases, we should really not make life difficult by giving huge patterns which are more difficult to read and which provide an accuracy which is more than the algorithm needs to begin with (PA is not linear, so nothing is gained by going to 0.001 accuracy). Aux fan: is anyone else experiencing the bug here? #8078 https://orcaslicer-docs.vercel.app/docs/calibration "Pattern method" should not repeat the instructions for adaptive PA. "Max Volumetric speed" should add this: Advanced users will know what to do, generic users will not start complaining about parts falling apart the first time they fall on the ground, or similar. |
I usually use the PA tower (it works fine in my setup), but I think I understand your point. I see 3 options :
|
Hey thanks for the detailed feedback, however, the contents there are just copied from the github wiki from about 2 months ago. Anyway, I don't want to hijack this PR any further with my alternative 😅. I agree with what @ianalexis has proposed above. So in that vein, here's my sales pitch haha My version from https://github.com/ndom91/orcaslicer-docs (demo deploy: https://orcaslicer-docs.vercel.app/docs) is using a JS docs framework (fumadocs) that comes with a nice UI out of the box and many little docs page widgets / features that would allow us to ship much nicer docs project than your average mkdocs or similar from the 3D printing ecosystem. It generates a static output bundle, so no running node server required. It's compatible with the whole JS remark/rehype ecosystem, unlocking a ton of expandability, and I've used it extensively at other opensource projects im involved with as well as at my previous job. I appreciate that the 3D printing community doesn't have a ton of overlap with web dev, but that whole part really doesn't need much work / maintenance after we ship it once, I've already done all of that work in the repo above as well as copied over all of the content from the GH wiki (as of ~2 months ago at this point, as you pointed out can definitely use some updates). The docs content itself is written in markdown files, in this case in the Long story short, this project / version of the docs is already ready to ship imo. Of course only if we agree, but from there it's basically just @SoftFever that would then need to help out with pointing the Regarding Vercel, it's just a hosting provider for this static site. They have a relatively good free tier and a great dev experience imo, but it really doesn't matter what we go with. Happy to chat about this as well |
I am working from mobile or, in little scraps of time, from my work PC :) so I can only contribute in discussions like this one or in Discord, provided it's a Discord discussion without background noise, so few people contributing in a concise and efficient manner, not messages lost in a long dispersive chat with 50 people writing one line or two and disappearing (discussing here already filters this kind of noise). Maybe better merge this one to the Github one, then sync the two, then we can efficiently iterate on corrections in the external one, and once done propose a change to the official wiki. |
c55425a
to
0f24b6a
Compare
0f24b6a
to
988545c
Compare
f0fd9a7
to
2332627
Compare
Refactored the "How to Build" page using the steps from the current README, and updated the Windows section accordingly. |
16817b9
to
73403e7
Compare
Removed the fake sites from the main README because listing them poses a real risk. To avoid this, I replaced the list with a simpler CAUTION message and added clearer, more prominent official links and badges. @SoftFever @Noisyfox consider applying this change either in this PR or in a separate one if you don’t find all the other proposed changes necessary. |
5815f5c
to
f14080d
Compare
Co-Authored-By: Rodrigo <162915171+RF47@users.noreply.github.com>
Co-Authored-By: Rodrigo <162915171+RF47@users.noreply.github.com>
Update How-to-build.md
Now using the one in \print_settings\calibration
Shortern Winget commands Added individual brew
Co-Authored-By: Michele Stefanelli <mhzdev@gmail.com> Co-Authored-By: Jack_up <36533859+GiacomoGuaresi@users.noreply.github.com>
7dbac35
to
2370dfe
Compare
Improve the wiki with the following goals:
Tried to keep as much as possible the previous guide and its descriptions.
These improvements will also make future integration with documentation tools like MkDocs (like here #7497) much smoother and more maintainable.