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

FPCF Tutorial for Website #21

Merged
merged 27 commits into from
May 27, 2021
Merged

FPCF Tutorial for Website #21

merged 27 commits into from
May 27, 2021

Conversation

errt
Copy link
Collaborator

@errt errt commented May 4, 2021

Adds a tutorial for the fixed-point computation framework to the website.
Includes changes to the site generation and templates to allow for pages outside of the top level directory.

@errt errt requested review from TorunR and roterEmil May 4, 2021 14:33
@svenkeidel svenkeidel self-requested a review May 5, 2021 07:12
@svenkeidel
Copy link
Collaborator

@errt, how can I build the tutorial documentation?

@errt
Copy link
Collaborator Author

errt commented May 5, 2021

sbt generateSite, then look for it in target/scala-2.12/resource_managed. However, viewing this locally won't work very well.

@svenkeidel
Copy link
Collaborator

Thanks for the hard work you put into this tutorial.

The main point you can improve: It is hard/impossible to understand some methods, because their code is scattered across multiple pages. Readers have to stitch these listings together in their heads. I propose you show larger coherent listings and refer to specific code pieces by line numbers.

Here is my detailed feedback: opal-tutorial.pdf

@errt errt merged commit bc84c8f into develop May 27, 2021
@errt errt deleted the feature/website branch May 27, 2021 10:08
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