Skip to content

refactor(docs): adapt server routes to b24jssdk (were copied from b24ui)#137

Merged
IgorShevchik merged 1 commit into
mainfrom
claude/rework-docs-server-routes
Jun 7, 2026
Merged

refactor(docs): adapt server routes to b24jssdk (were copied from b24ui)#137
IgorShevchik merged 1 commit into
mainfrom
claude/rework-docs-server-routes

Conversation

@IgorShevchik

Copy link
Copy Markdown
Collaborator

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 to components.md / composables / typography pages that don't exist here, and pointed GitHub: at github.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):
    • correct title / description (sourced from the repo's own index.yml + nuxt-llms config);
    • SDK feature list (B24Frame / B24Hook / B24OAuth, REST v2/v3, batch, helpers, logging, TS);
    • real installation pages (vue / nuxt / react / nodejs / umd);
    • real sections + entry points (getting-started, working-with-the-rest-api, frame / hook / oauth);
    • GitHub:github.com/bitrix24/b24jssdk; EN/RU community links (resolves the inline @todo);
    • drop the stale // …/b24ui DOMAIN comment.
  • raw/[...slug].md.get.ts — drop the stale // …/b24ui comment; fold the two duplicated not-found responses into a single notFound() helper.
  • sitemap.xml.get.ts — drop the stale // …/b24ui comment.
  • sitemap.md.get.ts — audited: already b24jssdk-correct (section labels match real content), no change.

Verification

  • ✅ No b24ui reference remains anywhere under docs/server/routes/.
  • ⏳ The server routes compile under the docs-build (nuxt generate) and typecheck CI 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).

📝 Please eyeball the new index.md wording/links — it's public, LLM-facing content; happy to tweak the feature bullets or link set.

Out of scope (proposed follow-ups)

https://claude.ai/code/session_01977J3EFoxeffXCHS2TE7Kw


Generated by Claude Code

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
@IgorShevchik IgorShevchik merged commit a1a19d3 into main Jun 7, 2026
8 checks passed
@IgorShevchik IgorShevchik deleted the claude/rework-docs-server-routes branch June 7, 2026 06:19
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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants