Repository navigation
feat: двотрекова документація в адмінці (/admin/docs) - #99
Merged
Merged
Conversation
- Custom Payload admin view (/admin/docs, exact:false) wrapped in DefaultTemplate,
with auth redirect, track switcher, breadcrumbs, prev/next pager
- Content: 59 Ukrainian articles in docs/admin-panel/{manager,technical} covering
every collection, hook, access rule, and business-logic sharp edge
- Renderer: marked + transliterated heading ids, :::callouts, scroll-wrapped
tables, external-link handling (src/lib/admin-docs)
- UX: client-side search (session-gated index API, Cmd+K), TOC scrollspy with
reading progress, collapsible category nav, client-side cross-link navigation
- Nav: 'Документація' section with two entry links via afterNavLinks
- outputFileTracingIncludes so md files reach Vercel serverless bundles
- Tests: renderer unit cases + real-content checks incl. cross-link resolvability
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Що зроблено
В адмін-панелі з'явився вбудований розділ документації /admin/docs з двома гілками (обидві лише українською):
/admin/docs/manager) — 25 статей для контент-менеджерів: курси (кроки, тести, JSON-імпорт, записи, сертифікати, наслідки редагування опублікованого), публікації/сторінки/чернетки/SEO/локалізація/медіа/перенаправлення/форми, користувачі, коментарі та лайки, XP, пошук, глобальні блоки, FAQ./admin/docs/technical) — 34 статті для розробників: архітектура і payload.config, повна модель даних (усі колекції та глобали з access/hooks/індексами), бізнес-логіка (завершення курсу, оцінювання тестів, XP, сертифікати, rate limiting), автентифікація (Better Auth, OTP, ролі, dev-login, аватари), інфраструктура (Neon, міграції, деплой, Blob, синхронізація локалей пошуку, email), процеси розробки (включно зі статтею про сам docs-viewer).У навігації адмінки додано секцію «Документація» з двома посиланнями (
afterNavLinks).Архітектура
docs/admin-panel/<track>/<NN-категорія>/<NN-стаття>.md;NN-префікс задає порядок і не входить у URL;_category.json— назва/опис категорії; frontmatter —title+description. Нова стаття = новий файл, dev підхоплює одразу.src/lib/admin-docs/: лоадер (кеш лише в production) і рендерер наmarked: транслітеровані якорі заголовків, колаути:::info|tip|warning|danger, таблиці зі скролом, зовнішні лінки в новій вкладці.views.docs,path: '/docs',exact: false) вDefaultTemplateз auth-redirect; сайдбар з перемикачем треків і згортуваними категоріями; хлібні крихти; попередня/наступна стаття./api/admin-docs/search-index(сніпети, результати з обох треків).router.push).outputFileTracingIncludesвключає md-дерево в серверний бандл (перевірено в прод-збірці: 70 файлів у nft обох маршрутів).Тести
tests/int/admin-docs.int.spec.ts— 13 тестів: рендерер (якорі, дедуплікація, колаути, екранування, таблиці) + перевірки реального контенту, зокрема валідація всіх внутрішніх крос-посилань (битий лінк валить CI) і сканер на просочений сирий markdown.Перевірено
tsc, ESLint, повнийtest:int(єдиний новий фейл був очікуваним до завершення контенту)pnpm build+ nft-трасування md-файлів)🤖 Generated with Claude Code