Skip to content

Исправить проблемы и неточности в текущих статьях #3

Description

@vaid-via

Обнаруженные проблемы

  • introduction.md: ссылки на GitHub (issues, discussions) ведут на заглушки; стиль обращения к читателю скачет между «ты» и «Вы»; отсутствует упоминание лицензии.
  • policy.md: таблица типов данных заполнена частично; упоминается хранение никнейма в localStorage, но эта функциональность нигде не реализована. Следует либо убрать упоминание, либо добавить страницу для задания никнейма. Разделы «Использование данных» и «Хранение и защита» требуют конкретизации.
  • about_notes.md: фраза «честно — почти никакой» вводит в заблуждение; стоит описать, что записи хранятся в Markdown, а сайт обеспечивает навигацию. Временную серию SomeStrangeSeries переименовать или удалить; ссылка на курс algocourses.ru неактивна.
  • avrora.md, breaded_bread.md: название репозитория указано как TEDU_Notes вместо Vadim‑Khristenko/Tedu_Notes; списки изменений оформлены непоследовательно.
  • why_you_SHOULD_use_linters.md: заглавие написано заглавными буквами и воспринимается как крик; стоит переименовать в обычный регистр («Why you should use linters»), изменить метаданные серии, разделить материал на две части, убрать избыточные эмодзи, пояснить асимптотику и добавить ссылки на конкретные инструменты (clang‑tidy, cppcheck).

Предложенные исправления

  • Обновить ссылки на GitHub и добавить упоминание лицензии.
  • Привести стиль обращения к единому формату.
  • Заполнить таблицу данных в policy.md и уточнить разделы, либо добавить страницу для задания никнейма.
  • Обновить about_notes.md: описать назначение сайта и структуру файлов, пересмотреть временную серию и добавить корректную ссылку на курс.
  • Исправить название репозитория во всех статьях; привести списки изменений к стандартному виду.
  • Разделить статью о линтерах на две части, привести заголовок и стиль к нормальному виду, уменьшить количество эмодзи, добавить ссылки на реальные линтеры и пояснить сложные термины.

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't workingdocumentationImprovements or additions to documentationenhancementNew feature or request

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions