-
Notifications
You must be signed in to change notification settings - Fork 261
[nika_install] Мануалы по правильной установке NIKA, изменению и добавлению функций. #384
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
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This pull request adds Russian-language installation and usage documentation for the NIKA project (version 0.2.2). The documentation addresses a missing Docker container issue and provides step-by-step guides for installation, function modification, and knowledge base creation.
Key Changes
- Installation guide with detailed prerequisites and commands for running NIKA 0.2.2
- Tutorial for modifying project functions (demonstrated through changing lab work deadlines)
- Manual for creating knowledge bases in NIKA (demonstrated through adding month data)
Reviewed changes
Copilot reviewed 3 out of 9 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| nika_install/doc/Readme.md | Main installation guide with system requirements and setup commands |
| nika_install/doc/readmeKostyan.md | Guide for modifying existing NIKA functions and responses |
| nika_install/doc/readmeIgor.md | Tutorial for creating and extending knowledge bases |
| nika_install/images/grnbut.jpg | Screenshot showing green button UI element |
| nika_install/images/2.jpg | Screenshot showing NIKA interface example |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
nika_install/doc/Readme.md
Outdated
|
|
||
| # Запуск проекта **NIKA** на новейшей версии **0.2.2** | ||
| ## Введение | ||
| В данном документе описана "починка" **NIKA**, а также описан метод добавления функций и изменения ответов данной OSTIS-системы. Следуя шагам мануала главного репозитория **[NIKA](https://github.com/ostis-apps/nika)** по установке проекта, вы обязательно столкнётесь с проблемой нехватки контейнера **ostis/nika:0.2.2** на **DockerHub**. Поэтому данный "гайд" поможет вам наконец-таки насладиться всей мощью **NIKA 0.2.2**. |
Copilot
AI
Dec 19, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The title contains inconsistent spacing in the project version number. "NIKA 0.2.2" in line 2 vs "NIKA на новейшей версии 0.2.2" in line 2. The formatting should be consistent throughout the document.
| В данном документе описана "починка" **NIKA**, а также описан метод добавления функций и изменения ответов данной OSTIS-системы. Следуя шагам мануала главного репозитория **[NIKA](https://github.com/ostis-apps/nika)** по установке проекта, вы обязательно столкнётесь с проблемой нехватки контейнера **ostis/nika:0.2.2** на **DockerHub**. Поэтому данный "гайд" поможет вам наконец-таки насладиться всей мощью **NIKA 0.2.2**. | |
| В данном документе описана "починка" **NIKA**, а также описан метод добавления функций и изменения ответов данной OSTIS-системы. Следуя шагам мануала главного репозитория **[NIKA](https://github.com/ostis-apps/nika)** по установке проекта, вы обязательно столкнётесь с проблемой нехватки контейнера **ostis/nika:0.2.2** на **DockerHub**. Поэтому данный "гайд" поможет вам наконец-таки насладиться всей мощью **NIKA** версии **0.2.2**. |
nika_install/doc/Readme.md
Outdated
| ``` | ||
| #### 3. Build knowledge base: | ||
| ``` | ||
| /scripts/start.sh build_kb |
Copilot
AI
Dec 19, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missing forward slash at the beginning of the path. The command should be "./scripts/start.sh build_kb" (with a dot) instead of "/scripts/start.sh build_kb".
| /scripts/start.sh build_kb | |
| ./scripts/start.sh build_kb |
nika_install/doc/Readme.md
Outdated
| cd interface | ||
| npm install | ||
| npm run build | ||
| Run React interface: |
Copilot
AI
Dec 19, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The code block is not properly closed. The "Run React interface:" text on line 72 should be outside the code block. There's a missing closing backticks (```) after line 71, and the text on line 72 should not be inside the code block.
| Run React interface: |
| grep -R "ваш искомый объект (срок защиты)" knowledge-base/ | ||
|
|
||
| ``` | ||
| Проходимся по файлам с раширением ***.scs**, где найдено вхождение. Найдя интересующий нас файл и меняем в нём дату сдачи: |
Copilot
AI
Dec 19, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Typo in the word "расширением". It's spelled as "раширением" but should be "расширением".
| Проходимся по файлам с раширением ***.scs**, где найдено вхождение. Найдя интересующий нас файл и меняем в нём дату сдачи: | |
| Проходимся по файлам с расширением ***.scs**, где найдено вхождение. Найдя интересующий нас файл и меняем в нём дату сдачи: |
| 4) Помечаем язык текста. | ||
| Конструкция (* <- lang_ru;; *) помечает соответствующую текстовую ссылку ролью/меткой lang_ru, то есть указывает, что содержимое — на русском языке. | ||
|
|
||
| Делаем так с оставшимеся месяцами и сохраняем файл. |
Copilot
AI
Dec 19, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Typo in the word "оставшимися". It's spelled as "оставшимеся" but should be "оставшимися" (instrumental case of the plural form).
| Делаем так с оставшимеся месяцами и сохраняем файл. | |
| Делаем так с оставшимися месяцами и сохраняем файл. |
| ## Введение | ||
| Данный документ содержит мануал по созданию базы знаний для проекта **NIKA**. Здесь рассмотрено добавление базы месяцев для ответа на вопрос о сроке сдачи первой лабораторной работы. | ||
| ## Поиск нужной директории | ||
| Рекомендую просмотреть мануал **"Изменение функций проекта **NIKA 0.2.2**"** для поиска нужного вам файла. |
Copilot
AI
Dec 19, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Inconsistent reference format. In line 5, the reference is formatted as "мануал "Изменение функций проекта NIKA 0.2.2"" which has unbalanced asterisks. The proper format should have the entire reference text in quotes with consistent bold formatting applied to the title.
| Рекомендую просмотреть мануал **"Изменение функций проекта **NIKA 0.2.2**"** для поиска нужного вам файла. | |
| Рекомендую просмотреть мануал "**Изменение функций проекта NIKA 0.2.2**" для поиска нужного вам файла. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Caution
Changes requested ❌
Reviewed everything up to 6449df3 in 2 minutes and 42 seconds. Click for details.
- Reviewed
213lines of code in3files - Skipped
6files when reviewing. - Skipped posting
4draft comments. View those below. - Modify your settings and rules to customize what types of comments Ellipsis leaves. And don't forget to react with 👍 or 👎 to teach Ellipsis.
1. nika_install/doc/Readme.md:9
- Draft comment:
Typo: In the sentence "Там же, во вкладке "Быстрый старт", будет находится набор команд по установке NIKA.", consider changing "будет находится" to "будет находиться" for grammatical correctness. - Reason this comment was not posted:
Decided after close inspection that this draft comment was likely wrong and/or not actionable: usefulness confidence = 20% vs. threshold = 50% This is a typo/grammar correction in documentation. The comment is about a change (new file added). However, I need to consider the rules: "Do NOT comment unless there is clearly a code change required" and "Do NOT make comments that are obvious or unimportant." This is documentation, not code, and it's a minor grammatical error. The rules seem focused on code quality and logic issues. Grammar corrections in documentation might be considered "obvious or unimportant" depending on interpretation. However, the rule about "Use Descriptive Variable and Constant Names" and similar quality rules suggest that clarity matters. But this is just a typo in documentation text, not a code issue. The automated tool is being overly pedantic about a minor grammar issue in Russian documentation. While grammatical correctness is important for documentation quality, this is a very minor typo that doesn't affect understanding. The rules emphasize not making "obvious or unimportant" comments, and a single letter typo in documentation could fall into this category. Additionally, grammar/spelling corrections might be better handled by spell-checkers or separate documentation review processes rather than code review. Although the critique has merit, the comment does identify a genuine grammatical error that should be fixed for professional documentation. However, given the emphasis in the rules on avoiding unimportant comments and the fact that this is purely cosmetic with no functional impact, this falls below the threshold for a code review comment. This comment should be deleted. While it correctly identifies a grammatical error, it's a minor typo in documentation that falls under "obvious or unimportant" comments. The rules prioritize substantive code issues over cosmetic documentation fixes.
2. nika_install/doc/Readme.md:39
- Draft comment:
Typo: The command path "/scripts/start.sh build_kb" appears to have a leading slash. Should it be "./scripts/start.sh build_kb" to remain consistent with other script invocations? - Reason this comment was not posted:
Marked as duplicate.
3. nika_install/doc/readmeIgor.md:72
- Draft comment:
Typographical error: "оставшимеся" should be "оставшимися". - Reason this comment was not posted:
Decided after close inspection that this draft comment was likely wrong and/or not actionable: usefulness confidence = 35% vs. threshold = 50% This is a straightforward typo/grammar correction in documentation. The comment is about changed code (a new file), it's actionable (provides a clear fix), and it's correct (the Russian grammar is indeed wrong). However, I need to consider the rules: "Do NOT comment unless there is clearly a code change required" and "Do NOT make comments that are obvious or unimportant." This is documentation, not code, and it's a minor typo. The rules say not to comment on things that are "obvious or unimportant." A single grammatical error in documentation might be considered minor/unimportant, especially since it doesn't affect functionality. But it does affect documentation quality and readability. While this is a legitimate grammatical error, it's a very minor typo in documentation that doesn't affect functionality. The rules emphasize not making "obvious or unimportant" comments, and a single typo in documentation could be considered unimportant. Additionally, the rules focus on code quality issues, not documentation proofreading. However, documentation quality is important for user-facing materials, and this is a clear, actionable fix with a specific suggestion. The comment is not speculative, not asking for confirmation, and provides an exact correction. It's a legitimate quality improvement, even if minor. This is a borderline case - it's a correct and actionable grammar fix, but it's a minor typo in documentation. Given the emphasis on not making "unimportant" comments and the focus on code rather than documentation proofreading, I'll lean toward deleting this comment, though with moderate confidence.
4. nika_install/doc/readmeKostyan.md:24
- Draft comment:
Typographical error: "раширением" should be "расширением". - Reason this comment was not posted:
Decided after close inspection that this draft comment was likely wrong and/or not actionable: usefulness confidence = 20% vs. threshold = 50% This is a straightforward typo correction in documentation. The rules state that comments should not be made unless there is clearly a code change required, and to avoid obvious or unimportant comments. However, this is documentation, not code. The rules also mention that comments should be actionable and clear. A typo in documentation could be considered minor, but it does affect readability and professionalism. The rules don't explicitly exclude documentation corrections, but they emphasize not making obvious or unimportant comments. Typos in user-facing documentation are generally worth fixing, but the question is whether an automated tool should flag them. The rules seem focused on code logic issues rather than spelling corrections. The rules emphasize not making obvious or unimportant comments, and a simple typo might fall into that category. Additionally, spelling corrections in documentation might be considered too minor or could be caught by spell-checkers rather than code review tools. While typos might seem minor, documentation quality matters for user experience and professionalism. However, the rules clearly state to avoid obvious or unimportant comments, and a simple spelling error in documentation likely falls into this category, especially for an automated tool to flag. This comment should be deleted. While the typo correction is technically correct, it falls under "obvious or unimportant" comments that the rules explicitly say should not be made. Spelling errors in documentation are minor issues that don't require automated review comments.
Workflow ID: wflow_50YYnXuwKONlRw0z
You can customize by changing your verbosity settings, reacting with 👍 or 👎, replying to comments, or adding code review rules.
nika_install/doc/Readme.md
Outdated
| ``` | ||
| #### 3. Build knowledge base: | ||
| ``` | ||
| /scripts/start.sh build_kb |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Inconsistent command prefix: '/scripts/start.sh build_kb' should likely be prefixed with ./ for consistency with other commands.
| /scripts/start.sh build_kb | |
| ./scripts/start.sh build_kb |
nika_install/doc/Readme.md
Outdated
| cd interface | ||
| npm install | ||
| npm run build | ||
| Run React interface: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove non-command text ('Run React interface:') from within the code block to avoid confusion.
| Run React interface: |
| grep -R "ваш искомый объект (срок защиты)" knowledge-base/ | ||
|
|
||
| ``` | ||
| Проходимся по файлам с раширением ***.scs**, где найдено вхождение. Найдя интересующий нас файл и меняем в нём дату сдачи: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Typo detected: 'раширением' should be 'расширением'; also consider formatting the file extension as inline code (e.g., .scs).
| Проходимся по файлам с раширением ***.scs**, где найдено вхождение. Найдя интересующий нас файл и меняем в нём дату сдачи: | |
| Проходимся по файлам с расширением `.scs`, где найдено вхождение. Найдя интересующий нас файл и меняем в нём дату сдачи: |
Updated the README to clarify the versioning of NIKA and fixed minor formatting issues.
Important
Adds detailed installation, knowledge base creation, and function modification guides for NIKA 0.2.2 in
nika_install/doc.Readme.mddetailing installation and setup for NIKA 0.2.2, including prerequisites and step-by-step instructions.readmeIgor.mdexplaining how to create a knowledge base for NIKA, focusing on adding month data.readmeKostyan.mdproviding a guide on modifying NIKA functions, specifically changing response data for lab work deadlines.This description was created by
for 6449df3. You can customize this summary. It will automatically update as commits are pushed.