update documentation: simplify introduction and points structure, refine rules on task deadlines and reports

Author: allnes

.github/workflows/pages.yml

@@ -37,18 +37,22 @@ jobs:
         uses: actions/setup-python@v6
         with:
           python-version: '3.13'
-      - name: Install Doxygen
+      - name: Install Doxygen and Graphviz
         run: |
           sudo apt-get update
-          sudo apt-get install --no-install-recommends -y doxygen
+          sudo apt-get install --no-install-recommends -y doxygen graphviz
       - name: Install dependencies
         run: |
           python3 -m pip install -r docs/requirements.txt
+          python3 -m pip install graphviz pyyaml
       - name: Download artifact
         uses: actions/download-artifact@v5
         with:
           name: doxygen-documentation-xml
           path: xml
+      - name: Generate CI jobs graph
+        run: |
+          python3 scripts/jobs_graph.py --out docs/_static/ci_graph --format svg
       - name: Configure project
         run: >
           cmake -S . -B build -D USE_DOCS=ON

README.md

@@ -23,43 +23,7 @@ Coverage report is available [here](https://learning-process.github.io/parallel_
 
 ## Quickstart
 
-Build
------
-- Configure: `cmake -S . -B build [-DENABLE_ADDRESS_SANITIZER=ON]`
-- Build: `cmake --build build -j`
-- Optional install: `cmake --install build --prefix install`
-
-Run tests locally (preferred)
------------------------------
-Set environment and use the helper runner:
-
-```
-export PPC_NUM_THREADS=4
-export PPC_NUM_PROC=2
-
-# Shared-memory tests
-python3 scripts/run_tests.py --running-type threads --counts 1 2 4
-
-# MPI tests
-python3 scripts/run_tests.py --running-type processes --counts 2 4
-
-# Performance
-python3 scripts/run_tests.py --running-type performance
-```
-
-Scoreboard generation
----------------------
-- `pip install -r scoreboard/requirements.txt`
-- `python3 scoreboard/main.py -o scoreboard/out`
-
-Docs
-----
-- `cmake -S . -B build -DUSE_DOCS=ON`
-- `cmake --build build -t docs_html`
-
-Pre-commit
-----------
-- `pre-commit install && pre-commit run -a`
+See the full user guide for build, tests, docs, and tooling instructions: [documentation en](https://learning-process.github.io/parallel_programming_course/en/), [documentation ru](https://learning-process.github.io/parallel_programming_course/ru/).
 
 ### Rules for submissions:
 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).

docs/_static/ci_graph.svg

@@ -1,12 +1,6 @@
 Introduction
 ============
 
-Contacts
-~~~~~~~~
-
-- Alexander Nesterov — nesterov.alexander@outlook.com
-- Arseniy Obolenskiy — me@gooddoog.ru
-
 Practice
 ~~~~~~~~
 
@@ -21,8 +15,8 @@ Practice
 - Full automation of quality and performance checks; plagiarism checks are applied.
 - Deadlines are set per task. See the penalties and grading rules in ``Points``.
 - Examples are provided in ``tasks/example_threads`` and ``tasks/example_processes`` (and extended variations ``tasks/example_processes_2`` / ``tasks/example_processes_3``).
-- In each repository, the README.md contains a link to the course documentation (**read it fully!!!**).
-- Additionally, each repository includes an example of a properly formatted PULL REQUEST.
+- In each repository, the README.md contains a link to the course documentation.
+- Each repository includes an example of a properly formatted PULL REQUEST.
 - Submission of all tasks is mandatory to pass the course.
 - A task that has been merged into the master branch continues to be monitored.
   If a task fails in the master, it is disabled, and a record of this is added to the score table.
@@ -39,28 +33,4 @@ Communication
 - Feedback form — critical issues
 - Email — non‑urgent matters
 
-Next steps
-~~~~~~~~~~
-
-- Practice 1 (intro): task distribution, brief talk on parallelism, MPI examples
-- Practice 2 (repo usage): repository checks and project structure walkthrough
-
-- All resources for using the repository will be provided here:
-
-  - `Git for half an hour: A Beginner’s Guide <https://proglib.io/p/git-for-half-an-hour>`__
-  - `Getting Started with Git and GitHub: A Beginner’s Guide <https://medium.com/nuances-of-programming/%D0%B7%D0%BD%D0%B0%D0%BA%D0%BE%D0%BC%D1%81%D1%82%D0%B2%D0%BE-%D1%81-git-%D0%B8-github-%D1%80%D1%83%D0%BA%D0%BE%D0%B2%D0%BE%D0%B4%D1%81%D1%82%D0%B2%D0%BE-%D0%B4%D0%BB%D1%8F-%D0%BD%D0%B0%D1%87%D0%B8%D0%BD%D0%B0%D1%8E%D1%89%D0%B8%D1%85-54ea2567d76c>`__
-  - `Git: A Quick Start Guide to Using Core Operations with Explanations <https://tproger.ru/translations/git-quick-start/>`__
-  - `Conflicts resolving in Git <https://githowto.com/ru/resolving_conflicts>`__
-  - `Google testing framework (gtest) <https://habr.com/ru/post/119090/>`__
-  - `GoogleTest Primer <https://github.com/google/googletest/blob/main/docs/primer.md>`__
-  - `GitHub Actions documentation <https://docs.github.com/ru/actions>`__
-  - `Parallel Programming Technologies. Message Passing Interface (MPI) <https://parallel.ru/vvv/mpi.html#p1>`__
-  - `Typing and Layout in the System LaTeX <https://www.mccme.ru/free-books/llang/newllang.pdf>`__
-  - `LaTeX for the beginners <https://web.archive.org/web/20210420184700/http://www.docs.is.ed.ac.uk/skills/documents/3722/3722-2014.pdf>`__
-  - `What is OpenMP? <https://parallel.ru/tech/tech_dev/openmp.html>`__
-  - `TBB-1 <https://web.archive.org/web/20220406024622/http://www.unn.ru/pages/e-library/aids/2007/12.pdf>`__
-  - `Writing Multithreaded Applications in C++ <https://eax.me/cpp-multithreading/>`__
-  - `Multithreading: New Features of the C++11 Standard <https://web.archive.org/web/20200608173050/http://www.quizful.net/post/multithreading-cpp11>`__
-  - `Introduction to Parallel Computing <http://ikt.muctr.ru/images/info/2Lecture_3.pdf>`__
-
-\* *All instructions, repositories, and tables may be updated during the learning process for better usability. Be prepared for changes, check and update them periodically!!!*
+\* *All instructions, repositories, and tables may be updated during the learning process for better usability. Be prepared for changes and check updates periodically.*