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

/doc/users-guide/convert-a-c-program/ #8

Open
behoppe opened this issue May 19, 2022 · 3 comments · May be fixed by #102
Open

/doc/users-guide/convert-a-c-program/ #8

behoppe opened this issue May 19, 2022 · 3 comments · May be fixed by #102
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@behoppe
Copy link
Member

behoppe commented May 19, 2022

I created the Convert a C++ program page based on Dorothy's updates to the Cilk Plus programmer's guide. It could use a review. TB skimmed it and saw: "a couple formatting issues and one technical error. In addition, there are steps in the overview that are not reflected in the rest of the document."

@timkaler
Copy link
Contributor

timkaler commented May 24, 2022

How would you like to receive feedback? For example, here are a few options I can think of: annotated pdf printout of the page, editing the page and creating a pull request, providing individual corrections here. Also, are you looking for feedback on structure/organization?

I can see a few structural changes that might be beneficial to make --- e.g., explain the contents of the page concisely at the start of overview, and create a "Workflow for parallelizing an existing program" section containing the contents of the itemized list currently in overview.

@behoppe
Copy link
Member Author

behoppe commented May 24, 2022

Thanks, Tim. If it works for you, please edit the page and create a pull request. I would love feedback on structure and organization as well. This page right now reflects our ability to migrate a doc from Cilk Plus to OpenCilk. With your feedback, I think we might start a bigger process of making our new documentation work as effectively as possible.

If you run into any issues installing your local instance of the website, please let me know.

@behoppe behoppe added the documentation Improvements or additions to documentation label Jun 16, 2022
@behoppe behoppe added this to the Version 1.0 milestone Jun 16, 2022
@behoppe
Copy link
Member Author

behoppe commented Jun 20, 2022

Hi @timkaler, thank you for confirming that you can review this article. Please ignore my earlier comment about creating a pull request, and use Netlify CMS as we discussed. In order to follow the website contribution process, I just updated the title of this issue to be the URL of the page that you're reviewing.

Contrary to what I said during our team Zoom, you can edit an existing article with Netlify CMS, and the existing content will remain visible. Your proposed edits go into a new branch, which does not get merged into the main branch until you finally "publish" your edits.

Thank you for your contributions to OpenCilk.

@behoppe behoppe changed the title Convert a C++ program /doc/users-guide/convert-a-c-program/ Jul 13, 2022
@behoppe behoppe linked a pull request Jul 29, 2022 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants