Skip to content

docs(link): bring the overview page in line with the proofread text (#DS-5797) - #2257

Draft
rmnturov wants to merge 3 commits into
mainfrom
docs/DS-5797-link-article-edits
Draft

rmnturov wants to merge 3 commits into
mainfrom
docs/DS-5797-link-article-edits

Conversation

@rmnturov

@rmnturov rmnturov commented Oct 27, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Статья про KbqLink приведена к вычитанному тексту. PR стоит поверх #2238 (ветка docs/DS-3539): там сама перепись страницы, здесь — правки после вычитки.

List of notable changes:

  • updated link.{en,ru}.mdx: разделы Содержимое и Страница перехода убраны, порядок и заголовки — по вычитке, вводный абзац переписан с сохранением KbqLink для поиска
  • removed раздел «Работа с клавиатурой» и три пункта рекомендаций — на вычитке их убрали намеренно
  • updated сгенерированные артефакты: seo-descriptions.ts, llms.txt

Пометку вычитки «добавить русские примеры» не реализуем: у остальных примеров link локализации нет, и один локализованный пример выбивался бы из набора — это отдельное решение, не часть этой правки.

What should reviewers focus on?

  • Совпадает ли текст страницы с вычиткой: заголовки, порядок разделов, формулировки про атрибуты.
  • Не потерялось ли что-то нужное из удалённых пунктов рекомендаций и из разделов, которых в вычитке нет.

Проверки: prettier, cspell, eslint, build:docs-pages (302 страницы), check-llms, unit:tools (253 теста), build:docs-examples, docs:build (398 маршрутов).

@rmnturov rmnturov self-assigned this Oct 27, 2026
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Oct 27, 2026
@rmnturov
rmnturov requested a review from NikGurev October 27, 2026 12:30
@github-actions

github-actions Bot commented Oct 27, 2026 •

Copy link
Copy Markdown

Visit the preview URL for this PR (updated for commit 397d0ac):

https://koobiq-next--prs-2257-76ualax8.web.app

(expires Fri, 30 Oct 2026 13:50:06 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

Sign: c9e37e518febda70d0317d07e8ceb35ac43c534c

@artembelik
artembelik requested a balanced review from Copilot October 27, 2026 12:52

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔵 Needs a closer look

The shared link-prepositions example uses Russian copy that renders on the English overview page, an intentional deviation the author explicitly flagged for human reviewer judgment.

1 open issue
What changed in this PR

This PR aligns the KbqLink overview documentation page with the proofread (vychitka) text, layered on top of #2238 which rewrote the page. It reorders and retitles sections, rewrites the intro and attribute descriptions, removes the "Content"/"Destination" grouping, the "Keyboard" table, and three recommendation bullets, and adds a new shared link-prepositions example for the "Prepositions and punctuation" section. Generated artifacts are regenerated to stay in sync.

Changes:

  • Reworked link.en.mdx / link.ru.mdx: new intro, flattened section hierarchy (prefix ###), tightened attribute wording, removed keyboard table and two recommendation items.
  • Added link-prepositions-example.ts and registered it in index.ts.
  • Regenerated example-module.ts, loader/index.ts, seo-descriptions.ts, and llms.txt.
File Description
packages/​components/​link/​link.en.mdx Rewrites intro/sections, removes keyboard table and two recommendations, adds link-prepositions reference.
packages/​components/​link/​link.ru.mdx Russian counterpart of the same restructuring.
packages/​docs-examples/​components/​link/​link-prepositions/​link-prepositions-example.ts New example demonstrating prepositions/punctuation; uses Russian copy that also renders on the EN page.
packages/​docs-examples/​components/​link/​index.ts Registers the new example (import, export, EXAMPLES).
packages/​docs-examples/​example-module.ts Generated metadata entry for link-prepositions; matches sibling structure.
packages/​docs-examples/​loader/​index.ts Generated lazy-loader case for link-prepositions.
apps/​docs/​src/​app/​seo-descriptions.ts Generated SEO description updated to the new intro (EN + RU).
apps/​docs/​src/​llms.txt Generated LLM index line updated to the new EN intro.

Review effort: Balanced

Comment on lines +11 to +17
<p class="example-text">
Подробнее
<a kbqLink href="https://koobiq.io/ru/main/typography/overview">
о типографике
<span kbqLinkSuffix>.</span>
</a>
</p>
@rmnturov
rmnturov force-pushed the docs/DS-5797-link-article-edits branch from 4f50da1 to 41c2a3e Compare October 27, 2026 13:21
…#DS-5797)

- flatten the sections and put them in the order the proofread text has
- rename the sections: disabled state, third-party application, print version,
  prepositions and punctuation
- drop the keyboard section and shorten the recommendations, as the proofread text does
- regenerate the SEO descriptions and llms.txt
@rmnturov
rmnturov force-pushed the docs/DS-5797-link-article-edits branch from 41c2a3e to 397d0ac Compare October 27, 2026 13:44
Base automatically changed from docs/DS-3539 to main October 27, 2026 15:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants