diff --git a/README.md b/README.md index 1fd84289a..e33f96a3b 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,7 @@ [![codecov](https://codecov.io/gh/learning-process/parallel_programming_course/graph/badge.svg?token=qCOtqeFyIz)](https://codecov.io/gh/learning-process/parallel_programming_course) # Parallel Programming Course +Welcome to the Parallel Programming Course! For more detailed documentation and resources, please visit [documentation page](https://learning-process.github.io/parallel_programming_course/). ### Parallel programming technologies: The following parallel programming technologies are considered in practice: @@ -15,9 +16,3 @@ 1. You are not supposed to trigger CI jobs by frequent updates of your pull request. First you should test you work locally with all the scripts (code style). * Respect others time and don't slow down the job queue 2. Carefully check if the program can hang. - -### Steps to create a task: -1. [Download all submodules](docs/download.rst) -2. [Set up your environment](docs/environment.rst) -3. [Build the project with `CMake`](docs/build.rst) -4. [How to submit your current work](docs/submit_work.rst) diff --git a/docs/index.rst b/docs/index.rst index cc5df2d62..603e91093 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,17 +1,13 @@ -.. Parallel Programming Course documentation master file, created by - sphinx-quickstart on Sat Jan 11 23:09:04 2025. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - Parallel Programming Course documentation ========================================= -Add your content using ``reStructuredText`` syntax. See the -`reStructuredText `_ -documentation for details. - +Below is the table of contents for the Parallel Programming Course documentation. Follow the links to learn more about each topic. .. toctree:: :maxdepth: 2 - :caption: Contents: + :caption: User Guide: + user_guide/build + user_guide/download + user_guide/environment + user_guide/submit_work diff --git a/docs/build.rst b/docs/user_guide/build.rst similarity index 100% rename from docs/build.rst rename to docs/user_guide/build.rst diff --git a/docs/download.rst b/docs/user_guide/download.rst similarity index 100% rename from docs/download.rst rename to docs/user_guide/download.rst diff --git a/docs/environment.rst b/docs/user_guide/environment.rst similarity index 100% rename from docs/environment.rst rename to docs/user_guide/environment.rst diff --git a/docs/submit_work.rst b/docs/user_guide/submit_work.rst similarity index 100% rename from docs/submit_work.rst rename to docs/user_guide/submit_work.rst