cadquery
cadquery copied to clipboard
CadQuery
Revamping Cheatsheet
This PR includes a revamped cheatsheet. It includes more information on the most common commands. Some commands have been excluded from this first draft at rewriting the cheatsheet, any important ones I missed can certainly be added, just let me know. Addresses issue #1128.
I've also made some changes to the README to link to the documentation more clearly under the "Getting Started" header, including a link to the cheatsheet.
Finally, made a few stylistic fixes to that part of the README, added a link to a VSCode extension. This part is more optional, but figured I'd include it, no worries if we need to drop it.
Codecov Report
Merging #1129 (b964226) into master (d5806e3) will not change coverage. The diff coverage is
n/a.
@@ Coverage Diff @@
## master #1129 +/- ##
=======================================
Coverage 94.01% 94.01%
=======================================
Files 26 26
Lines 5411 5411
Branches 918 918
=======================================
Hits 5087 5087
Misses 193 193
Partials 131 131
:mega: We’re building smart automated test selection to slash your CI/CD build times. Learn more
![codecov[bot] avatar](https://avatars.githubusercontent.com/in/254?v=4 "Published by a pub.dev verified publisher"){kind=small}
Quick preview for anyone interested, while we wait for PR!
https://4k6570.csb.app/
@jpoles1 Thanks for putting this together. It might just be because I'm on mobile, but the border goes all the way around some tables, but not others.
@jmwright yea, that's a problem on mobile specifically that I'm aware of, will try and fix soon!
@jmwright, I think it might benefit from adding a few more key commands before final review. Also potentially a few more of the key params for commonly used functions. Might solicit some feedback from the discord crew, and then request final review!
Still working on tuning this resource, and I think making some nice improvements! I think this latest version will be well optimized for a variety of different screen sizes. I've also started to add some fancier functionality, like the all-important "dark mode"! https://jpoles1.github.io/CadQuery-Cheatsheet/
I thinking I want to keep going with incremental development in this separate repo for now, and potentially merge back in down the line once I feel it's adequately polished. Open to suggestions, of course! I think I may close this PR for now and re-open in the future?
@jpoles1 It looks good so far. If you would rather wait to merge that's fine, but what you have is already an improvement over what exists right now. I see that it has embedded Javascript to toggle the light/dark mode. Will the cheatsheet fail to load if someone has Javascript disabled for some reason?
Hey @jmwright , apologies for the hiatus, work's been keeping me busy. I've been using the cheatsheet on and off while working on CadQuery projects, and I'm pretty happy with how it's looking for now!
None of the page should require JS, it's only there for switching between day + night mode. I tested disabing JS and confirmed it works just fine!
What do you think is the best way to move forward:
- Leave it hosted on my repo and simply link to it from the docs/readme.
- should I merge the code into the repo, so it'd theoretically appear here? Not sure when/how often the readthedocs is updated/regenerated.
(I've maintained it as a single page html file, similar to the old version).
In either case, I'd also like to make a link to the Cheatsheet near the top of the readme for easy access (not sure exactly where). I was thinking of a small little section (maybe right underneath the badges) for quick access to the most important links out (Docs/Cheatsheet/Discord/etc).
Also, would it be ok to add a quick link to the cheatsheet to the sidebar in the ReadTheDocs? Perhaps right under the CadQuery Examples sidebar link?
What do you think is the best way to move forward:
ReadTheDocs should be updated whenever we push to the main branch of the repo, so your cheatsheet should go live soon after this PR is merged. I think ReadTheDocs would be the most stable place to link to from the readme.
I was thinking of a small little section (maybe right underneath the badges) for quick access to the most important links out (Docs/Cheatsheet/Discord/etc).
A quick links section at the top of the readme sounds like a good idea to me. You might want to include a link for the Google Group too for those who don't use Discord.
Also, would it be ok to add a quick link to the cheatsheet to the sidebar in the ReadTheDocs? Perhaps right under the CadQuery Examples sidebar link?
I think a cheatsheet link in the sidebar on ReadTheDocs would be fine.
Alright, I think it's all set! So to summarize:
- Revamps cheatsheet
- Adds links quickbar to top of readme
- Adds link to cheatsheet from docs
Please let me know if any issues I need to correct, thanks!
@jmwright agh, I think I messed that up in the merge. I had moved it up the readme earlier and then there were edits made in the mean time which have made a mess of it. Lemme try and figure out how to remove that from the PR...
I think that should fix it... let me know if I mixed up anything else, my apologies.
@roipoussiere Am I understanding correctly that cadquery-server has replaced the VSCode extension that you created? So should the link here point to cadquery-server's VSCode instructions instead?
@jpoles1 I was just about to recommend merging this, but then the question above occurred to me. I think your changes look good though, and we can move forward on merging once the VSCode extension question is resolved.
@adam-urbanczyk @lorenzncode How does this PR look to you two?
@jmwright I had this in mind but in fact I decided to continue to maintain VSCode extension. So there is no need to edit the readme, I will probably update the extension in the next cq-server release and the instructions about vscode in the cq-server readme will be removed.
