refactor(docs): adapt server routes to b24jssdk (were copied from b24ui)#137
Merged
Conversation
The docs/server/routes/* handlers were copied from the sibling b24ui project and never adapted, so the raw-markdown surface (consumed by LLMs) described the wrong product. - raw/index.md: rewrite the hardcoded landing body to describe @bitrix24/b24jssdk (REST API SDK) instead of the b24ui component library — correct title/description, SDK feature list, real installation pages (vue/nuxt/react/nodejs/umd), real sections (getting-started, working-with-the-rest-api, frame/hook/oauth), the b24jssdk GitHub repo, and EN/RU community links (resolves the inline @todo). Drop the stale b24ui DOMAIN comment. - raw/[...slug].md: drop the stale b24ui DOMAIN comment; fold the two duplicated not-found responses into one helper. - sitemap.xml: drop the stale b24ui DOMAIN comment. - sitemap.md: audited — already b24jssdk-correct, no change. Out of scope for this issue (docs/server/routes only): residual b24ui cruft in docs/server/utils/transformMDC.ts, and the RU docs mirror (separate, English-only repo). Refs #133 https://claude.ai/code/session_01977J3EFoxeffXCHS2TE7Kw
2 tasks
IgorShevchik
added a commit
to bitrix-tools/b24jssdk
that referenced
this pull request
Jun 7, 2026
Port of upstream bitrix24/b24jssdk#137 to the RU mirror (mirror half of bitrix24/b24jssdk#133). The handlers under docs/server/routes/ were copied from the sibling b24ui project and never adapted: raw/index.md described the wrong product (Bitrix24 UI — a Vue component library, 125+ components) and pointed GitHub at bitrix24/b24ui. - raw/index.md.get.ts: rewrite the landing body to describe @bitrix24/b24jssdk (B24Frame / B24Hook / B24OAuth, REST v2/v3, batch, helpers, logging, TS), real installation + section links, GitHub -> bitrix24/b24jssdk, EN/RU community links; drop the stale b24ui DOMAIN comment and the MCP/@todo block (MCP was already removed from the RU mirror in #26/#128). - raw/[...slug].md.get.ts: fold the two duplicated not-found responses into a single notFound() helper; drop the stale b24ui comment. - sitemap.xml.get.ts: drop the stale b24ui comment. - sitemap.md.get.ts: audited, already b24jssdk-correct, no change. No b24ui reference remains under docs/server/routes/. Out of scope (separate follow-up, as in #137): residual b24ui cruft in docs/server/utils/transformMDC.ts. Closes #28.
IgorShevchik
added a commit
to bitrix-tools/b24jssdk
that referenced
this pull request
Jun 7, 2026
…ui) (#42) Port of upstream bitrix24/b24jssdk#137 to the RU mirror (mirror half of bitrix24/b24jssdk#133). The handlers under docs/server/routes/ were copied from the sibling b24ui project and never adapted: raw/index.md described the wrong product (Bitrix24 UI — a Vue component library, 125+ components) and pointed GitHub at bitrix24/b24ui. - raw/index.md.get.ts: rewrite the landing body to describe @bitrix24/b24jssdk (B24Frame / B24Hook / B24OAuth, REST v2/v3, batch, helpers, logging, TS), real installation + section links, GitHub -> bitrix24/b24jssdk, EN/RU community links; drop the stale b24ui DOMAIN comment and the MCP/@todo block (MCP was already removed from the RU mirror in #26/#128). - raw/[...slug].md.get.ts: fold the two duplicated not-found responses into a single notFound() helper; drop the stale b24ui comment. - sitemap.xml.get.ts: drop the stale b24ui comment. - sitemap.md.get.ts: audited, already b24jssdk-correct, no change. No b24ui reference remains under docs/server/routes/. Out of scope (separate follow-up, as in #137): residual b24ui cruft in docs/server/utils/transformMDC.ts. Closes #28.
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
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.
Refs #133.
Problem
The handlers under
docs/server/routes/were copied from the sibling b24ui project and never adapted to b24jssdk. The most visible consequence:raw/index.md(the raw-markdown surface consumed by LLMs / AI agents at/raw/index.md) described the wrong product — it advertised "Bitrix24 UI… a Vue UI component library… 125+ Tailwind CSS components", linked tocomponents.md/composables/typographypages that don't exist here, and pointedGitHub:atgithub.com/bitrix24/b24ui.Changes (scope =
docs/server/routes/per the issue)raw/index.md.get.ts— rewrite the hardcoded landing body to describe@bitrix24/b24jssdk(the REST API SDK):index.yml+nuxt-llmsconfig);vue/nuxt/react/nodejs/umd);getting-started,working-with-the-rest-api,frame/hook/oauth);GitHub:→github.com/bitrix24/b24jssdk; EN/RU community links (resolves the inline@todo);// …/b24uiDOMAIN comment.raw/[...slug].md.get.ts— drop the stale// …/b24uicomment; fold the two duplicated not-found responses into a singlenotFound()helper.sitemap.xml.get.ts— drop the stale// …/b24uicomment.sitemap.md.get.ts— audited: already b24jssdk-correct (section labels match real content), no change.Verification
b24uireference remains anywhere underdocs/server/routes/.docs-build(nuxt generate) andtypecheckCI jobs on this PR — that's the authoritative check in the Nuxt/Nitro context (a fresh checkout here isn't provisioned for a local nuxt typecheck).Out of scope (proposed follow-ups)
docs/server/utils/transformMDC.ts(dead commented component-* code,components-listquerying/docs/components/%).https://claude.ai/code/session_01977J3EFoxeffXCHS2TE7Kw
Generated by Claude Code