Стартовая страница /api/overview + сортировка методов POST-first#257
Merged
Conversation
lookinway
force-pushed
the
models-post-first
branch
from
b13a7b5 to
f3a5c80
Compare
Документация API получила обзорную страницу (как лендинг), и наведён порядок в карточках методов на странице моделей. API Overview (/api/overview): - Новая стартовая страница с hero-макетом (как у главной): слева интро и абзац-подсказка (руководства, n8n без кода), справа панель с базовым URL, табами клиентов (CLI + 6 SDK) с командами установки и ссылками на доки, и карточками ресурсов (OpenAPI, Postman). - Секция «Популярные методы» (пилюли-ссылки) и «Основы API» карточками. - Стала landing-страницей вкладки API (defaultHref) + пункт «Обзор» в сайдбаре. - Общий переключатель LangTabs и хук useCodeLang: язык синхронизирован между панелью и примерами кода (CodeExamples получил variant="tabs"). - hideHeader во фронтматтере, чтобы не было двойной шапки. Страница моделей: - Бейджи и списки методов сортируются POST-first. - check-models-coverage.mjs в turbo check: падает, если эндпоинт спеки не упомянут на странице моделей (защита от дрейфа). Главная: описание переписано под портал в целом.
lookinway
force-pushed
the
models-post-first
branch
from
f3a5c80 to
6d500a5
Compare
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.
Что сделано
API Overview (
/api/overview)Новая обзорная (landing) страница документации API в hero-макете, как у главной:
defaultHref) + пункт «Обзор» в сайдбаре.LangTabs+ хукuseCodeLang: выбранный язык синхронизирован между панелью и примерами кода (уCodeExamplesдобавленvariant="tabs").hideHeaderво фронтматтере, чтобы не дублировалась шапка страницы.Страница моделей
scripts/check-models-coverage.mjsподключён вturbo check: сборка падает, если эндпоинт из спеки не упомянут на странице моделей (защита от дрейфа, аналог генерируемого меню).Главная
/api/overview).Проверки
turbo build+turbo checkзелёные (lint, typecheck, knip, format, test, check-models). Сгенерированныеpublic/*.mdиllms*.txtв синхроне.