Skip to content
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

A simple users guide overviewing the basic Cilk keywords and how to u… #238

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

neboat
Copy link
Contributor

@neboat neboat commented Jan 15, 2025

…se them.

This PR adds the first of several planned user guides and other documentation covering the basics of Cilk programming.

Copy link

netlify bot commented Jan 15, 2025

Deploy Preview for sage-licorice-6da44d ready!

Name Link
🔨 Latest commit a717291
🔍 Latest deploy log https://app.netlify.com/sites/sage-licorice-6da44d/deploys/6788fb8fda802b0008c1d7e0
😎 Deploy Preview https://deploy-preview-238--sage-licorice-6da44d.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@behoppe
Copy link
Member

behoppe commented Jan 15, 2025

Thanks @neboat. It's great to see new documentation. What sort of feedback or help would you like from me? I am happy to assist however you like.

The opening section of this documentation (about cilk_spawn and cilk_scope) has a lot in common with https://www.opencilk.org/doc/tutorials/introduction-to-cilk-programming/#adding-parallelism-with-cilk_scope-and-cilk_spawn, and I wonder if we might position them as one building on the other. Right now it seems odd that they don't mention each other.

I'm a bit surprised this doc is located in the users guide, which reinforces my sense that our original documentation framework ("users guide," "tutorial," "reference," etc) is only confusing us and is not serving us. If/when you would like help with organizing documentation, just let me know.

@neboat neboat force-pushed the basics-of-cilk-progrmming branch from 4fc1c6b to a717291 Compare January 16, 2025 12:29
@behoppe
Copy link
Member

behoppe commented Jan 16, 2025

Thanks @neboat I like the latest edits, and I'm curious what you think of my earlier feedback. If you want me to be the person who merges this, please let me know.

@neboat
Copy link
Contributor Author

neboat commented Jan 16, 2025

Hey @behoppe , thanks for your response.

Let me keep working on this and some associated docs for a bit longer. The pointer to the existing reference about cilk_scope and cilk_spawn is very helpful, but there's a slightly different organization of the information that I think can work quite well but I'm still sorting out. I'll try and add a couple of those associated docs to this PR in roughly the next week, so you can get some idea of the organization I have in mind.

Indeed, I'm still confused as to what qualifies as a "user guide" vs. a "tutorial" vs. a "reference." Let's come back to that question after I add a little more content.

@behoppe
Copy link
Member

behoppe commented Jan 16, 2025

OK @neboat sounds like a good plan :-)

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.

2 participants