Merge pull request #310 from rolling-scopes-school/sync-rsapp-docs

dzmitry-varabei · web-flow · commit 98f3be23ce44 · 2025-12-05T12:55:40.000+01:00
Sync RS APP documentation: Add missing files and update structure
diff --git a/docs/en/_sidebar.md b/docs/en/_sidebar.md
@@ -47,7 +47,7 @@
     - [Streaming](en/streaming.md)
 - Mentoring
   - [Pull Request Review Process](en/pull-request-review-process.md)
-- [RS APP](en/rsapp.md)
+- [RS APP](en/rs-app.md)
 - [How to contribute](en/how-to-contribute.md)
 - [About The Rolling Scopes](en/rolling-scopes-overview.md)
 - [Support community](en/fundraiser.md)
diff --git a/docs/en/docsMenu_en.json b/docs/en/docsMenu_en.json
@@ -229,8 +229,25 @@
     ]
   },
   {
-    "title": "RS APP",
-    "link": "rsapp"
+    "title": "RS APP Platform",
+    "items": [
+      {
+        "title": "Overview",
+        "link": "rs-app"
+      },
+      {
+        "title": "Submitting Assignments in RS APP",
+        "link": "rs-app-tasks"
+      },
+      {
+        "title": "Cross check",
+        "link": "cross-check-flow"
+      },
+      {
+        "title": "Typical Problems",
+        "link": "rs-app-issues"
+      }
+    ]
   },
   {
     "title": "How to contribute",
diff --git a/docs/en/rs-app-issues.md b/docs/en/rs-app-issues.md
@@ -0,0 +1,25 @@
+## Action Algorithm "What to do if something doesn't work in RS APP?"
+
+1. First check if someone has already described this problem in [rsschool-app](https://github.com/rolling-scopes/rsschool-app/issues). If the problem is described, you just need to leave a comment in the corresponding issue stating that the problem is relevant for you as well. If there's no similar problem, proceed to step 2.
+2. Ask about the problem in the corresponding Discord channel (all assignments have their own channel). Wait for responses from other students/activists. If the problem is not solved, proceed to step 3.
+3. Ask about the problem in the **#questions-to-rsapp** Discord channel. Wait for comments from activists/admins. If the problem is not solved, proceed to step 4.
+4. Create a new issue with a description of the problem in the [rsschool-app](https://github.com/rolling-scopes/rsschool-app/issues) repository
+
+## Typical Problems and Their Solutions
+
+1. No access to the course, **"No access"** error
+
+   ![No Access. Probably you do not participate in the course. Please register or choose another course.](../images/no-access.png)
+
+   **Solution:** register for the desired course using [this link](https://app.rs.school/registry/student)
+
+2. I don't know how to see my errors in an automatically checked assignment (**Auto-test**)
+
+   **Solution:** go to [app.rs.school](https://app.rs.school) and go to the **Auto-test** section, select the desired assignment. Verification details will be displayed in the **Details** column:
+
+   ![Auto-test assignment verification results](../images/autotest-details.jpg)
+
+3. I submitted an assignment and got points, but there are no changes in **Score**.
+
+   **Solution:** wait. It takes a little time for changes to be displayed — usually it takes 5 minutes.
+
diff --git a/docs/en/rs-app-tasks.md b/docs/en/rs-app-tasks.md
@@ -0,0 +1,75 @@
+# Submitting Assignments in RS App
+
+All assignments must be submitted in RS App **before the deadline**:
+
+- Auto-checked tasks are submitted on the `Auto-Test` page. These include: tests, algorithmic assignments, codewars assignments.
+- In case of Cross-Check assignment review, you need to submit the required link on the `Cross-check: Submit` page before the deadline. After submitting the link, you can continue working on the assignment until the deadline. The link can be submitted multiple times - the last one is saved. Everyone who didn't provide their work on time receives 0.
+
+## Tests
+
+- Tests for theoretical modules are in the `Auto-Test` tab in [RS App](https://app.rs.school/).
+- Each test has a minimum passing score indicated in the description for each test (usually 70% of the maximum possible points).
+- You can take the test the number of times indicated in the description. The last result counts.
+- Also (if indicated), you can take the test more times, but the test score will be reduced by half.
+- The test result will be displayed immediately. It will be added to `Score` after statistics update (at 04:00 GMT+3).
+
+## Algorithmic Assignments
+
+- [Example assignment](https://github.com/AlreadyBored/basic-js)
+- Scores for these tasks are summed in the overall `Score`, as with all other assignments. The coefficient for each assignment is indicated in the `Weight` column in the schedule or in the detailed assignment description in `Score`.
+- After finishing work on an assignment, go to [RS App](https://app.rs.school/), select `Auto-Test`, click `Open Task` in the desired assignment, click the `Start task` button, click the `Submit` button, then click `Refresh` or refresh the page. The verification result will be displayed in the `Score` column. If errors appear during verification, they will be described in the `Details` column.
+- You can submit an assignment as many times as you want, each subsequent submission overwrites the previous one.
+- Cheating on tasks ⇒ expulsion. Think carefully before submitting someone else's code just to get 10 points. We don't require solving all tasks.
+- If during an interview you don't know how you solved the assignment you submitted ⇒ it was cheating ⇒ expulsion.
+- If during an interview you know how you solved the assignment, but can't solve an obviously simpler task ⇒ it was cheating ⇒ expulsion.
+
+#### Can I retake algorithmic assignments?
+
+Yes, as many times as you want, but before the deadline.
+
+#### How to find an error when solving algorithmic tasks?
+
+- `console.log()` input parameters at the beginning of the solution
+- you can run only one test to reduce the number of logs
+  `mocha ./test/<TEST_NAME>.test.js`
+  or
+  `npm run test ./test/task-name.test.js`
+- You can comment out everything except the failing test in the test itself
+- You can [set up debugging in VSC](https://code.visualstudio.com/docs/nodejs/nodejs-debugging) and step through to see what's wrong.
+- You can use [this service](http://pythontutor.com/javascript.html#mode=edit) to visually debug code.
+
+## Codewars
+
+Some assignments require solving several tasks on the [Codewars](https://www.codewars.com/) website
+
+After finishing work on an assignment, go to [RS App](https://app.rs.school/), select `Auto-Test`, click `Open Task` in the desired assignment, click the `Start task` button, check that your Codewars username matches the displayed username\*, click the `Submit` button, then click `Refresh` or refresh the page. The verification result will be displayed in the `Score` column. If errors appear during verification, they will be described in the `Details` column.
+
+You can submit an assignment as many times as you want, each subsequent submission overwrites the previous one.
+
+_\*You can change your Codewars username via [this link](https://www.codewars.com/users/edit). Insert the specified username in the `Username` field and click the `Update` button at the very bottom of the page._
+
+![edit username](../images/rs-app-tasks-1.jpg)
+
+## Cross-check
+
+Detailed description of the cross-check process [here](cross-check-flow.md)
+
+### CodeJam
+
+This is a task whose description is not known in advance, and limited time is allocated for completion (from 60 minutes to 48 hours).
+For example, on Friday at 21:00 everyone receives a link with an assignment, for which 48 hours are allocated.
+
+## FAQ
+
+### What to do if I can't take a test or submit an assignment on time?
+
+Skip it and try to complete the remaining assignments.
+
+### Can I take task solutions from the internet?
+
+In all possible sources, it's acceptable to take an idea, but not a solution.
+
+### When can I submit a link in cross-check?
+
+We recommend submitting the link as early as possible. You can complete a small part of the assignment, submit the link, and then continue working on the assignment until the deadline.
+
diff --git a/docs/en/rs-app.md b/docs/en/rs-app.md
@@ -0,0 +1,58 @@
+## Rolling Scopes School Application
+
+Rolling Scopes School Application, or RS App, is an open-source platform used in the learning process at RS School and developed by community activists.
+
+Links:
+
+- [app.rs.school](https://app.rs.school) - school learning platform
+- [rs school app repository](https://github.com/rolling-scopes/rsschool-app)
+- [docs.rs.school](https://docs.rs.school) - school documentation
+- [documentation repository](https://github.com/rolling-scopes-school/docs)
+
+## Main RS App Sections:
+
+- **Dashboard** - section for tracking key student learning performance indicators
+- **Score** - complete list of students enrolled in the course, with total points scored. Updated daily at 04:00 GMT+3
+- **Schedule** - course schedule, as well as assignment dates, deadlines, and links to assignment descriptions
+- **Cross-Check: Submit** - section for submitting links to assignments that are checked using cross-check
+- **Cross-Check: Review** - section where assignments that the student needs to review during cross-check are located
+- **Interviews** - list of scheduled interviews with a mentor and their results
+- **Auto-Test** - section for automatic assignment checking (tests, algorithmic tasks, and codewars tasks)
+- [**Gratitude**](https://app.rs.school/gratitude) — section for sending gratitude. Someone helped you solve a task, found a bug, or just did a quality review? Don't be afraid to write a thank you!
+- [**Heroes page**](https://app.rs.school/heroes) — table displaying students who try not only to gain knowledge but also to share it! All gratitude from the Gratitude page goes here.
+
+## Q&A
+
+### How to enroll in a course in RS App?
+
+You can enroll in upcoming courses [via this link](https://app.rs.school/registry/student).
+
+### How to understand that I have successfully enrolled in a course?
+
+Go to [RS App](https://app.rs.school/), check that the desired course is displayed in the course list.
+Then open the Score tab. If you see your name in the first row of the table, congratulations, you have successfully enrolled in the course.
+
+### How to understand if I can enroll in a course that has already started?
+
+If [on the registration page](https://app.rs.school/registry/student) you can select the desired course from the course list, then you can still enroll in it.
+
+### How can I leave a course in RS App?
+
+To leave a course, click the "Leave course" button in [your profile](https://app.rs.school/profile). The course itself will remain in the course list, but you will no longer be able to complete assignments and track statistics.
+
+**Attention!** Clicking this button excludes the student but leaves the possibility to rejoin the course independently by clicking the "Back to Course" button.
+
+#### My `Total` on the Score page didn't update after taking a test, what should I do?
+
+`Total` is updated once per day at 04:00 GMT+3
+
+## Overview
+
+[Webinar recording "How to study in RS App"](https://www.youtube.com/watch?v=v_69DaeZ7dM&feature=youtu.be) - 1 hour
+
+## A unique opportunity to improve your karma right now
+
+1. Open the [RS School App repository](https://github.com/rolling-scopes/rsschool-app)
+2. Press the **:star: Star** button
+3. Congratulations, your RS School karma has improved :innocent:
+
diff --git a/docs/en/rsapp.md b/docs/en/rsapp.md
