Skip to content

Documentation website (including first Tutorial) - #109

Merged
michel-steuwer merged 12 commits into
masterfrom
tutorial
Feb 22, 2021
Merged

Documentation website (including first Tutorial)#109
michel-steuwer merged 12 commits into
masterfrom
tutorial

Conversation

@michel-steuwer

Copy link
Copy Markdown
Member

Added Tutorial app showing a basic overview of RISE and ELEVATE being used together.

This PR adds some additional syntax and functions to make the ELEVATE site a bit easier to understand (in the context of the tutorial).

There are also two bug fixes included:

  • the default traversal order of ELEVATE programs now follows more closely the execution order making specifying traversals more intuitive
  • a bug in the OpenMP vectorization code

Comment thread src/main/scala/rise/elevate/rules/lowering.scala Outdated
Comment thread src/main/scala/rise/elevate/rules/traversal.scala
Comment thread src/main/scala/apps/Tutorial.scala Outdated
@michel-steuwer michel-steuwer changed the title Tutorial Documentation website (including first Tutorial) Feb 17, 2021
@michel-steuwer

Copy link
Copy Markdown
Member Author

This PR now also adds a documentation website, that is automatically deployed at: https://rise-lang.org/doc/

The process works as follows:

  • Every markdown file that is added to the /docs/ folder corresponds to a page in the documentation
  • Scala code that is embedded in these markdown files is checked to compile and run using mdoc (This is automatically run by the CI on every commit of a PR).
  • The documentation website is powered by Docusaurus and configured in the /docs-website/ folder. The documentation page is deployed automatically on every successfully merged PR.
  • The documentation website is hosted using GitHub pages on the gh-pages branch of the doc repository and publicly accessible at: https://rise-lang.org/doc/

@michel-steuwer

michel-steuwer commented Feb 17, 2021

Copy link
Copy Markdown
Member Author

I have integrated the content from #89 in the documentation.
@umazalakain I, therefore, suggest closing #89 in favour of this PR.

Comment thread docs-website/yarn.lock
Comment thread .github/workflows/documentation.yml
Comment thread .github/workflows/documentation.yml
@Bastacyclop

Copy link
Copy Markdown
Member

@michel-steuwer Its great to have a documentation website! maybe we can combine this with API docs auto-generated from our source code in the future? (so docs embedded in our code as well as code embedded in our docs)

@michel-steuwer

Copy link
Copy Markdown
Member Author

@Bastacyclop thanks for the review. I have addressed all your comments. Could you have a final look and give your ok, or raise more points.

Comment thread src/main/scala/rise/elevate/rules/traversal.scala
@michel-steuwer
michel-steuwer merged commit df301cf into master Feb 22, 2021
@michel-steuwer
michel-steuwer deleted the tutorial branch February 22, 2021 11:40
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