Skip to content

feat: add GitBook deprecation banner to every page#45

Merged
springzhang-kite merged 3 commits into
mainfrom
deprecate-gitbook-developer-docs
Jun 4, 2026
Merged

feat: add GitBook deprecation banner to every page#45
springzhang-kite merged 3 commits into
mainfrom
deprecate-gitbook-developer-docs

Conversation

@springzhang-kite
Copy link
Copy Markdown
Collaborator

@springzhang-kite springzhang-kite commented May 25, 2026

Summary by CodeRabbit

  • Documentation
    • Added deprecation banners across the site and changelogs directing readers to docs.gokite.ai and the new docs repository for issues; pages will redirect at cutover.
  • Chores
    • CI workflows updated to allow manual rebuilds.
    • Added an automation tool to insert/update deprecation banners site-wide.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 25, 2026

Review Change Stack

📝 Walkthrough

Walkthrough

Adds an idempotent Node.js script to insert a standardized DEPRECATION-BANNER and applies that banner to 61 Markdown docs, directing readers to docs.gokite.ai and the gokite-ai/kite-docs issue tracker.

Changes

Documentation Deprecation Banner Rollout

Layer / File(s) Summary
Deprecation banner automation script
scripts/add-deprecation-banner.mjs
CLI script that walks the repository, detects page-level Markdown files, preserves YAML frontmatter, idempotently inserts or replaces a DEPRECATION-BANNER block, skips configured paths, writes only changed files, and logs updated counts.
Automated banner rollout across documentation
README.md, changelog/*, dev/README.md, docs/*, get-started*/*, integration-guide/*, kite-agent-passport/*, kite-chain/*, .github/workflows/*
A standardized 6-line deprecation banner block was inserted at the top of 61 Markdown files (after frontmatter when present). Two GitHub Actions workflows were adjusted to include/limit workflow_dispatch triggers.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

Poem

🐰 "A tiny script that hops and files away,

Banners bloom atop each doc today,
Pointing readers to the bright new site,
Issues sent where the maintainers write,
I nibble changes cleanly — then I say hooray!"

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title accurately describes the main change: adding deprecation banners to documentation pages across the repository.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch deprecate-gitbook-developer-docs

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 6

🧹 Nitpick comments (4)
scripts/add-deprecation-banner.mjs (1)

62-69: ⚡ Quick win

Consider more granular error handling for individual file operations.

Currently, if any single file read or write fails (e.g., due to permissions), the entire script terminates via the catch handler on line 74. For a bulk-update script operating on 61 files, it would be more resilient to log individual failures and continue processing remaining files.

♻️ Proposed enhancement with per-file error handling
   let updated = 0;
+  let failed = 0;
   for (const rel of files) {
     const full = path.join(root, rel);
-    const src = await readFile(full, 'utf8');
-    const next = applyBanner(src);
-    if (next !== src) {
-      await writeFile(full, next, 'utf8');
-      updated += 1;
+    try {
+      const src = await readFile(full, 'utf8');
+      const next = applyBanner(src);
+      if (next !== src) {
+        await writeFile(full, next, 'utf8');
+        updated += 1;
+      }
+    } catch (err) {
+      console.error(`Failed to process ${rel}:`, err.message);
+      failed += 1;
     }
   }
-  console.log(`Updated ${updated}/${files.length} files.`);
+  console.log(`Updated ${updated}/${files.length} files${failed > 0 ? ` (${failed} failed)` : ''}.`);
+  if (failed > 0) process.exit(1);
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@scripts/add-deprecation-banner.mjs` around lines 62 - 69, Wrap the per-file
work inside the for loop (where files, rel, full, src, next, updated are used)
in its own try/catch so a single readFile/applyBanner/writeFile failure does not
abort the whole run; specifically, inside the loop around the calls to
readFile(full, 'utf8'), applyBanner(src) and writeFile(full, next, 'utf8') catch
the error, log a clear message that includes the file path (full) and the error,
and then continue to the next iteration—keep the outer catch for unexpected
fatal errors but make the loop resilient by handling per-file errors locally.
kite-chain/10-layerzero-kite-integration/README.md (1)

1-5: 💤 Low value

Consider adding a timeline to the deprecation notice.

The deprecation banner mentions "at cutover" but doesn't specify when this will occur. Consider adding an approximate date or timeline to help users plan accordingly.

Example:

-**⚠️ These docs are moving to a new home.** Preview the new site at [docs-preview.gokite.ai](https://docs-preview.gokite.ai). At cutover, this site will redirect there automatically.
+**⚠️ These docs are moving to a new home.** Preview the new site at [docs-preview.gokite.ai](https://docs-preview.gokite.ai). This site will redirect there automatically on [DATE/Q3 2026].
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@kite-chain/10-layerzero-kite-integration/README.md` around lines 1 - 5,
Update the deprecation banner block (the <!-- DEPRECATION-BANNER:START --> ...
{% endhint %} <!-- DEPRECATION-BANNER:END --> section) to include an approximate
cutover timeline or date; edit the hint content string that currently reads
"**⚠️ These docs are moving to a new home.** Preview the new site..." to append
a short sentence like "Expected cutover: <approximate date or timeframe>
(subject to change)" or similar, so users can plan ahead while keeping the
existing link and issue guidance intact.
kite-chain/4-building-dapps/voting-dapp.md (1)

7-7: ⚡ Quick win

Consider adding a cutover timeline for user clarity.

The banner states "At cutover, this site will redirect there automatically" but doesn't specify when cutover will occur. Consider adding a target date or timeline (e.g., "Cutover planned for June 2026") to help users plan accordingly.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@kite-chain/4-building-dapps/voting-dapp.md` at line 7, Update the banner text
that currently reads "At cutover, this site will redirect there automatically"
to include a clear cutover timeline or target date (e.g., "Cutover planned for
June 2026" or "Cutover targeted Q2 2026") so users can plan; locate and modify
the string in voting-dapp.md where the banner is defined and ensure the added
timeline is concise and visible alongside the existing redirect message.
kite-chain/9-gasless-integration/README.md (1)

2-4: ⚡ Quick win

Consider adding a cutover date or timeline for clarity.

The banner states "at cutover, this site will redirect there automatically" but doesn't specify when cutover will occur. Users might benefit from knowing whether to expect this change in days, weeks, or months, or at minimum, where they can find that information.

💡 Example with timeline information
 {% hint style="warning" %}
-**⚠️ These docs are moving to a new home.** Preview the new site at [docs-preview.gokite.ai](https://docs-preview.gokite.ai). At cutover, this site will redirect there automatically. File issues against [gokite-ai/kite-docs](https://github.com/gokite-ai/kite-docs).
+**⚠️ These docs are moving to a new home.** Preview the new site at [docs-preview.gokite.ai](https://docs-preview.gokite.ai). This site will redirect there automatically on [DATE]. File issues against [gokite-ai/kite-docs](https://github.com/gokite-ai/kite-docs).
 {% endhint %}

Or if the date is not yet determined:

 {% hint style="warning" %}
-**⚠️ These docs are moving to a new home.** Preview the new site at [docs-preview.gokite.ai](https://docs-preview.gokite.ai). At cutover, this site will redirect there automatically. File issues against [gokite-ai/kite-docs](https://github.com/gokite-ai/kite-docs).
+**⚠️ These docs are moving to a new home.** Preview the new site at [docs-preview.gokite.ai](https://docs-preview.gokite.ai). This site will redirect there automatically in the coming weeks. File issues against [gokite-ai/kite-docs](https://github.com/gokite-ai/kite-docs).
 {% endhint %}
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@kite-chain/9-gasless-integration/README.md` around lines 2 - 4, The warning
banner (the `{% hint style="warning" %}` block) lacks a cutover date or
timeline; update that banner to include either a specific cutover date, an
estimated timeframe (e.g., "expected in Q3 2026"), or a pointer to where users
can track the cutover status (e.g., a "Cutover status" link or note like "date
TBD — subscribe at ..."); modify the README.md banner text accordingly so it
clearly communicates timing or where to find updates.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@integration-guide/case-study-app-store.md`:
- Around line 1-6: Update the DEPRECATION-BANNER block to include an approximate
cutover timeline so readers can plan; edit the existing hint block (the /**⚠️
These docs are moving to a new home.** message inside <!--
DEPRECATION-BANNER:START --> ... :END -->) to append a short date or timeframe
(e.g., "Expected cutover: Month Year" or "Read-only after DATE") and a note
about when links/redirects will activate and where to file issues, keeping the
warning style consistent and concise.

In `@integration-guide/workflow-agent-builders.md`:
- Around line 1-6: The deprecation banner uses GitBook hint templating (`{% hint
style="warning" %}...{% endhint %}`) and points to potentially unreachable
targets; replace the GitBook-specific block with a plain Markdown warning (e.g.,
a bold "⚠️ These docs are moving..." paragraph or a standard blockquote) so it
renders everywhere, and update the two links (`docs-preview.gokite.ai` and
`github.com/gokite-ai/kite-docs`) to either publicly reachable URLs or mark them
as internal/private with a parenthetical note (e.g., "(internal preview)" or
"(private repo)") so readers know the access expectations.

In `@kite-agent-passport/beginner-setup.md`:
- Around line 5-9: Update the DEPRECATION-BANNER block in the
kite-agent-passport/beginner-setup.md file to replace the unreachable/404 links:
change the preview docs URL `https://docs-preview.gokite.ai` to a working docs
URL (e.g., `https://docs.gokite.ai`) and replace the broken repo link
`https://github.com/gokite-ai/kite-docs` with a valid repository or organization
URL (e.g., `https://github.com/gokite-ai` or the correct docs repo); ensure the
{% hint %} banner text and links are updated together so the banner points to
reachable targets and add a short TODO comment in the banner referencing the
correct repo if the exact repo URL is unknown.

In `@kite-chain/10-layerzero-kite-integration/README.md`:
- Around line 1-5: Update the deprecation banner links in README.md to point to
valid, reachable targets: replace the preview URL
`https://docs-preview.gokite.ai` with the correct preview host (or remove the
link) and update the repository reference `gokite-ai/kite-docs` to the actual
GitHub repo name (or remove the link) so both links resolve; edit the
HTML/Markdown block containing the banner (the <!-- DEPRECATION-BANNER:START -->
... {% endhint %} block) to use the corrected URLs or plain text if the targets
don't exist.

In `@kite-chain/4-building-dapps/voting-dapp.md`:
- Line 7: Update the deprecation banner text to use reachable URLs: replace the
preview site URL `https://docs-preview.gokite.ai` with the public site
`https://docs.gokite.ai` and update the GitHub repo link from
`https://github.com/gokite-ai/kite-docs` to
`https://github.com/gokite-ai/developer-docs` so the banner's links resolve
correctly (look for the banner string "**⚠️ These docs are moving to a new
home.** Preview the new site at" and update the two URLs accordingly).

In `@scripts/add-deprecation-banner.mjs`:
- Line 45: The RegExp construction directly interpolates BANNER_START and
BANNER_END into new RegExp(...) which is fragile; add an escape helper (e.g.,
escapeRegExp) and use it to escape BANNER_START and BANNER_END before building
the pattern (or build the regex with explicit escaped literals) so the pattern
becomes escapeRegExp(BANNER_START) + '[\\s\\S]*?' + escapeRegExp(BANNER_END) +
'\\n*'; update the call site that currently uses new
RegExp(`${BANNER_START}[\\s\\S]*?${BANNER_END}\\n*`) to use the escaped values
instead.

---

Nitpick comments:
In `@kite-chain/10-layerzero-kite-integration/README.md`:
- Around line 1-5: Update the deprecation banner block (the <!--
DEPRECATION-BANNER:START --> ... {% endhint %} <!-- DEPRECATION-BANNER:END -->
section) to include an approximate cutover timeline or date; edit the hint
content string that currently reads "**⚠️ These docs are moving to a new home.**
Preview the new site..." to append a short sentence like "Expected cutover:
<approximate date or timeframe> (subject to change)" or similar, so users can
plan ahead while keeping the existing link and issue guidance intact.

In `@kite-chain/4-building-dapps/voting-dapp.md`:
- Line 7: Update the banner text that currently reads "At cutover, this site
will redirect there automatically" to include a clear cutover timeline or target
date (e.g., "Cutover planned for June 2026" or "Cutover targeted Q2 2026") so
users can plan; locate and modify the string in voting-dapp.md where the banner
is defined and ensure the added timeline is concise and visible alongside the
existing redirect message.

In `@kite-chain/9-gasless-integration/README.md`:
- Around line 2-4: The warning banner (the `{% hint style="warning" %}` block)
lacks a cutover date or timeline; update that banner to include either a
specific cutover date, an estimated timeframe (e.g., "expected in Q3 2026"), or
a pointer to where users can track the cutover status (e.g., a "Cutover status"
link or note like "date TBD — subscribe at ..."); modify the README.md banner
text accordingly so it clearly communicates timing or where to find updates.

In `@scripts/add-deprecation-banner.mjs`:
- Around line 62-69: Wrap the per-file work inside the for loop (where files,
rel, full, src, next, updated are used) in its own try/catch so a single
readFile/applyBanner/writeFile failure does not abort the whole run;
specifically, inside the loop around the calls to readFile(full, 'utf8'),
applyBanner(src) and writeFile(full, next, 'utf8') catch the error, log a clear
message that includes the file path (full) and the error, and then continue to
the next iteration—keep the outer catch for unexpected fatal errors but make the
loop resilient by handling per-file errors locally.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: d7f05e03-2797-4a29-ad54-363c548361b5

📥 Commits

Reviewing files that changed from the base of the PR and between 09645da and a340a1c.

📒 Files selected for processing (66)
  • README.md
  • changelog/2026/2026-05-19-backend-v1-1-0.md
  • changelog/2026/2026-05-19-cli-v1-3-4.md
  • changelog/2026/2026-05-19-skills-v0-9-1.md
  • changelog/2026/2026-05-19-web-v1-2-0.md
  • changelog/README.md
  • dev/README.md
  • docs/STYLING_GUIDE.md
  • get-started-why-kite/tokenomics.md
  • get-started/README.md
  • get-started/architecture-and-design-pillars.md
  • get-started/core-concepts-and-terminology.md
  • get-started/introduction-and-mission.md
  • get-started/key-use-cases-and-players.md
  • get-started/whitepaper-references.md
  • integration-guide/README.md
  • integration-guide/api-agent-builder-guide.md
  • integration-guide/api-merchants-payment-providers.md
  • integration-guide/api-references.md
  • integration-guide/case-study-app-store.md
  • integration-guide/sdk-api-overview-for-developers/README.md
  • integration-guide/sdk-api-overview-for-developers/agent-builder-guide.md
  • integration-guide/sdk-api-overview-for-developers/merchant-integration-guide.md
  • integration-guide/workflow-agent-builders.md
  • integration-guide/workflow-merchants-payment-providers.md
  • integration-guide/workflow-overview.md
  • integration-guide/workflow-overview/README.md
  • integration-guide/workflow-overview/workflow-a-agent-builders.md
  • integration-guide/workflow-overview/workflow-b-merchants-and-payment-providers.md
  • kite-agent-passport/README.md
  • kite-agent-passport/add-kite-tokens-external-wallet.md
  • kite-agent-passport/beginner-setup.md
  • kite-agent-passport/cli-reference.md
  • kite-agent-passport/funding.md
  • kite-agent-passport/service-provider-guide.md
  • kite-chain/1-getting-started/README.md
  • kite-chain/1-getting-started/faqs.md
  • kite-chain/1-getting-started/network-information.md
  • kite-chain/1-getting-started/tools.md
  • kite-chain/10-layerzero-kite-integration/README.md
  • kite-chain/11-goldsky-kite-integration/README.md
  • kite-chain/12-lucid-kite-integration/README.md
  • kite-chain/2-fundamentals/README.md
  • kite-chain/2-fundamentals/blockchain-fundamentals.md
  • kite-chain/2-fundamentals/smart-contract-basics.md
  • kite-chain/3-developing/README.md
  • kite-chain/3-developing/counter-smart-contract-hardhat.md
  • kite-chain/3-developing/counter-smart-contract-remix.md
  • kite-chain/3-developing/setup-environment.md
  • kite-chain/3-developing/smart-contracts-list.md
  • kite-chain/3-developing/voting-smart-contract.md
  • kite-chain/4-building-dapps/README.md
  • kite-chain/4-building-dapps/counter-dapp.md
  • kite-chain/4-building-dapps/token-minter.md
  • kite-chain/4-building-dapps/voting-dapp.md
  • kite-chain/5-advanced/README.md
  • kite-chain/5-advanced/account-abstraction-sdk.md
  • kite-chain/5-advanced/multisig-wallet.md
  • kite-chain/6-reference.md
  • kite-chain/7-kite-node/README.md
  • kite-chain/7-kite-node/mainnet-network-information.md
  • kite-chain/7-kite-node/mainnet-node-operations.md
  • kite-chain/8-kite-stablecoin/stablecoin-gasless-transfer.md
  • kite-chain/9-gasless-integration/README.md
  • kite-chain/mica-whitepaper.md
  • scripts/add-deprecation-banner.mjs

Comment thread integration-guide/case-study-app-store.md
Comment thread integration-guide/workflow-agent-builders.md
Comment thread kite-agent-passport/beginner-setup.md
Comment thread kite-chain/10-layerzero-kite-integration/README.md
Comment thread kite-chain/4-building-dapps/voting-dapp.md Outdated
Comment thread scripts/add-deprecation-banner.mjs
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 3

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (2)
.github/workflows/changelog-commands.yml (1)

3-11: ⚠️ Potential issue | 🔴 Critical | ⚡ Quick win

Fix changelog-commands.yml trigger/context mismatch (manual dispatch won’t run commands).

workflow_dispatch is the only trigger (line 3), but both the job and steps are gated on github.event.issue and github.event.comment.body (lines 7-11, plus step if: guards). Those fields only exist for issue_comment events, so a manual dispatch will skip the job and never execute /regenerate or /skip.

🔧 Proposed fix: add the missing issue_comment trigger (or refactor the conditions)
 on:
   workflow_dispatch:
+  issue_comment:
+    types: [created]
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In @.github/workflows/changelog-commands.yml around lines 3 - 11, The workflow
currently only declares workflow_dispatch but the job-level and step-level
conditionals reference github.event.issue and github.event.comment.body (in the
dispatch job's if condition), which exist only for issue_comment events; add the
missing issue_comment trigger so those fields are present (e.g., include
issue_comment under the workflow's on: triggers) or alternatively refactor the
job/step if-conditions to only rely on workflow_dispatch inputs; update the
workflow's triggers (and any related conditionals) so jobs that check
github.event.issue.pull_request and github.event.comment.body run when invoked
via an issue comment or adjust the condition to use workflow_dispatch inputs
instead (reference: workflow_dispatch, jobs.dispatch and the if: condition using
github.event.issue.pull_request and github.event.comment.body).
.github/workflows/changelog-build.yml (1)

28-28: ⚠️ Potential issue | 🟠 Major

Add/Document GPG signing setup for changelog-bot (required by git commit -S)

The workflow runs git commit -S -m "chore(changelog): regenerate index", but searches for any GPG/signing/sign.*commit configuration in markdown docs and .github/workflows/ returned no matches—so there’s no documented setup for the changelog-bot user (or the token owner). Ensure the workflow (or a called action) imports/configures the GPG key so the signed commit can succeed.

Current snippet
git commit -S -m "chore(changelog): regenerate index"
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In @.github/workflows/changelog-build.yml at line 28, The workflow currently
calls git commit -S -m "chore(changelog): regenerate index" but doesn’t
provision a GPG key for the changelog-bot/token owner; add steps to import and
configure a GPG key and git user signing config before that commit.
Specifically, in the workflow that contains the git commit -S invocation add
secure retrieval of the bot's private key (from repository or org secrets), a
step to import it into gpg (or use actions/setup-gpg or sigstore action), set
GPG_TTY if needed, and configure git user.signingkey and user.email/name (or use
--author) so git commit -S succeeds; ensure the key is unlocked or configured
for non-interactive use and that the secret name is documented for maintainers.
🧹 Nitpick comments (1)
.github/workflows/changelog-build.yml (1)

4-4: ⚡ Quick win

Verify the operational impact of removing automatic triggers.

The changelog index will no longer rebuild automatically on pushes to main or PRs touching changelog/**. Since this workflow now runs only on manual dispatch, the team must remember to trigger it after changelog updates, or the published index may become stale.

Consider documenting when/how to manually trigger this workflow (e.g., in changelog/README.md or a CONTRIBUTING.md guide), or add a reminder comment in the PR template for changelog-related changes.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In @.github/workflows/changelog-build.yml at line 4, The workflow now only
exposes workflow_dispatch in changelog-build.yml so the changelog index won’t
rebuild automatically; add explicit developer guidance: update the changelog
README (or CONTRIBUTING guide) and the PR template to include a short
step-by-step note telling reviewers/maintainers how to manually trigger the
changelog-build.yml workflow via GitHub Actions (mentioning the
workflow_dispatch trigger name and where to find "Run workflow" in the Actions
tab), and include a reminder to run it whenever changelog/** files or the index
are changed.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@get-started/README.md`:
- Line 7: The deprecation banner in get-started/README.md does not match the
canonical BANNER_BLOCK in scripts/add-deprecation-banner.mjs; update the README
banner text to exactly match the BANNER_BLOCK constant in
scripts/add-deprecation-banner.mjs (or if you intend to change the canonical
text, update BANNER_BLOCK in scripts/add-deprecation-banner.mjs and then
regenerate the docs so all files use the same template), making sure the
wording, links, and punctuation are identical to avoid the automation
overwriting your change.

In `@kite-agent-passport/README.md`:
- Line 7: The README has two conflicting issue-report destinations: the top
deprecation blurb links to "gokite-ai/kite-docs" while another link points to
"gokite-ai/developer-docs/issues/new/choose"; update the secondary link to match
the canonical "https://github.com/gokite-ai/kite-docs" destination (or
vice-versa if you prefer the other repo) so both references point to the same
issue tracker, and make the link text/anchor consistent with the deprecation
notice in the README.

In `@kite-agent-passport/service-provider-guide.md`:
- Line 7: The page currently points issue reports to two different trackers: the
header deprecation notice links to https://github.com/gokite-ai/kite-docs while
the help footer still points to
https://github.com/gokite-ai/developer-docs/issues/new/choose; update the footer
so both references converge on the single canonical tracker (replace the footer
URL/text with the kite-docs link and matching wording from the deprecation
notice) and ensure the footer’s issue-reporting copy matches the header’s
phrasing.

---

Outside diff comments:
In @.github/workflows/changelog-build.yml:
- Line 28: The workflow currently calls git commit -S -m "chore(changelog):
regenerate index" but doesn’t provision a GPG key for the changelog-bot/token
owner; add steps to import and configure a GPG key and git user signing config
before that commit. Specifically, in the workflow that contains the git commit
-S invocation add secure retrieval of the bot's private key (from repository or
org secrets), a step to import it into gpg (or use actions/setup-gpg or sigstore
action), set GPG_TTY if needed, and configure git user.signingkey and
user.email/name (or use --author) so git commit -S succeeds; ensure the key is
unlocked or configured for non-interactive use and that the secret name is
documented for maintainers.

In @.github/workflows/changelog-commands.yml:
- Around line 3-11: The workflow currently only declares workflow_dispatch but
the job-level and step-level conditionals reference github.event.issue and
github.event.comment.body (in the dispatch job's if condition), which exist only
for issue_comment events; add the missing issue_comment trigger so those fields
are present (e.g., include issue_comment under the workflow's on: triggers) or
alternatively refactor the job/step if-conditions to only rely on
workflow_dispatch inputs; update the workflow's triggers (and any related
conditionals) so jobs that check github.event.issue.pull_request and
github.event.comment.body run when invoked via an issue comment or adjust the
condition to use workflow_dispatch inputs instead (reference: workflow_dispatch,
jobs.dispatch and the if: condition using github.event.issue.pull_request and
github.event.comment.body).

---

Nitpick comments:
In @.github/workflows/changelog-build.yml:
- Line 4: The workflow now only exposes workflow_dispatch in changelog-build.yml
so the changelog index won’t rebuild automatically; add explicit developer
guidance: update the changelog README (or CONTRIBUTING guide) and the PR
template to include a short step-by-step note telling reviewers/maintainers how
to manually trigger the changelog-build.yml workflow via GitHub Actions
(mentioning the workflow_dispatch trigger name and where to find "Run workflow"
in the Actions tab), and include a reminder to run it whenever changelog/**
files or the index are changed.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 954b14fd-53ca-4ae2-b97f-b06c33b4f27e

📥 Commits

Reviewing files that changed from the base of the PR and between a340a1c and fb12a2f.

📒 Files selected for processing (67)
  • .github/workflows/changelog-build.yml
  • .github/workflows/changelog-commands.yml
  • README.md
  • changelog/2026/2026-05-19-backend-v1-1-0.md
  • changelog/2026/2026-05-19-cli-v1-3-4.md
  • changelog/2026/2026-05-19-skills-v0-9-1.md
  • changelog/2026/2026-05-19-web-v1-2-0.md
  • changelog/README.md
  • dev/README.md
  • docs/STYLING_GUIDE.md
  • get-started-why-kite/tokenomics.md
  • get-started/README.md
  • get-started/architecture-and-design-pillars.md
  • get-started/core-concepts-and-terminology.md
  • get-started/introduction-and-mission.md
  • get-started/key-use-cases-and-players.md
  • get-started/whitepaper-references.md
  • integration-guide/README.md
  • integration-guide/api-agent-builder-guide.md
  • integration-guide/api-merchants-payment-providers.md
  • integration-guide/api-references.md
  • integration-guide/case-study-app-store.md
  • integration-guide/sdk-api-overview-for-developers/README.md
  • integration-guide/sdk-api-overview-for-developers/agent-builder-guide.md
  • integration-guide/sdk-api-overview-for-developers/merchant-integration-guide.md
  • integration-guide/workflow-agent-builders.md
  • integration-guide/workflow-merchants-payment-providers.md
  • integration-guide/workflow-overview.md
  • integration-guide/workflow-overview/README.md
  • integration-guide/workflow-overview/workflow-a-agent-builders.md
  • integration-guide/workflow-overview/workflow-b-merchants-and-payment-providers.md
  • kite-agent-passport/README.md
  • kite-agent-passport/add-kite-tokens-external-wallet.md
  • kite-agent-passport/beginner-setup.md
  • kite-agent-passport/cli-reference.md
  • kite-agent-passport/funding.md
  • kite-agent-passport/service-provider-guide.md
  • kite-chain/1-getting-started/README.md
  • kite-chain/1-getting-started/faqs.md
  • kite-chain/1-getting-started/network-information.md
  • kite-chain/1-getting-started/tools.md
  • kite-chain/10-layerzero-kite-integration/README.md
  • kite-chain/11-goldsky-kite-integration/README.md
  • kite-chain/12-lucid-kite-integration/README.md
  • kite-chain/2-fundamentals/README.md
  • kite-chain/2-fundamentals/blockchain-fundamentals.md
  • kite-chain/2-fundamentals/smart-contract-basics.md
  • kite-chain/3-developing/README.md
  • kite-chain/3-developing/counter-smart-contract-hardhat.md
  • kite-chain/3-developing/counter-smart-contract-remix.md
  • kite-chain/3-developing/setup-environment.md
  • kite-chain/3-developing/smart-contracts-list.md
  • kite-chain/3-developing/voting-smart-contract.md
  • kite-chain/4-building-dapps/README.md
  • kite-chain/4-building-dapps/counter-dapp.md
  • kite-chain/4-building-dapps/token-minter.md
  • kite-chain/4-building-dapps/voting-dapp.md
  • kite-chain/5-advanced/README.md
  • kite-chain/5-advanced/account-abstraction-sdk.md
  • kite-chain/5-advanced/multisig-wallet.md
  • kite-chain/6-reference.md
  • kite-chain/7-kite-node/README.md
  • kite-chain/7-kite-node/mainnet-network-information.md
  • kite-chain/7-kite-node/mainnet-node-operations.md
  • kite-chain/8-kite-stablecoin/stablecoin-gasless-transfer.md
  • kite-chain/9-gasless-integration/README.md
  • kite-chain/mica-whitepaper.md
✅ Files skipped from review due to trivial changes (39)
  • kite-chain/2-fundamentals/blockchain-fundamentals.md
  • kite-chain/7-kite-node/mainnet-network-information.md
  • kite-chain/6-reference.md
  • kite-chain/2-fundamentals/README.md
  • integration-guide/sdk-api-overview-for-developers/README.md
  • get-started/whitepaper-references.md
  • integration-guide/sdk-api-overview-for-developers/merchant-integration-guide.md
  • integration-guide/case-study-app-store.md
  • dev/README.md
  • kite-chain/1-getting-started/tools.md
  • kite-chain/7-kite-node/mainnet-node-operations.md
  • integration-guide/workflow-overview/workflow-b-merchants-and-payment-providers.md
  • docs/STYLING_GUIDE.md
  • kite-chain/12-lucid-kite-integration/README.md
  • changelog/2026/2026-05-19-backend-v1-1-0.md
  • kite-chain/3-developing/voting-smart-contract.md
  • kite-chain/3-developing/README.md
  • kite-chain/mica-whitepaper.md
  • kite-chain/8-kite-stablecoin/stablecoin-gasless-transfer.md
  • kite-chain/7-kite-node/README.md
  • kite-agent-passport/cli-reference.md
  • kite-agent-passport/add-kite-tokens-external-wallet.md
  • integration-guide/workflow-overview/workflow-a-agent-builders.md
  • kite-chain/2-fundamentals/smart-contract-basics.md
  • changelog/2026/2026-05-19-web-v1-2-0.md
  • kite-chain/5-advanced/README.md
  • get-started/architecture-and-design-pillars.md
  • integration-guide/workflow-merchants-payment-providers.md
  • changelog/README.md
  • kite-chain/10-layerzero-kite-integration/README.md
  • integration-guide/sdk-api-overview-for-developers/agent-builder-guide.md
  • kite-chain/3-developing/counter-smart-contract-remix.md
  • kite-agent-passport/funding.md
  • get-started/core-concepts-and-terminology.md
  • integration-guide/api-references.md
  • get-started-why-kite/tokenomics.md
  • kite-agent-passport/beginner-setup.md
  • changelog/2026/2026-05-19-skills-v0-9-1.md
  • get-started/introduction-and-mission.md
🚧 Files skipped from review as they are similar to previous changes (13)
  • integration-guide/workflow-overview/README.md
  • kite-chain/4-building-dapps/counter-dapp.md
  • kite-chain/3-developing/counter-smart-contract-hardhat.md
  • kite-chain/1-getting-started/faqs.md
  • integration-guide/workflow-agent-builders.md
  • changelog/2026/2026-05-19-cli-v1-3-4.md
  • integration-guide/api-merchants-payment-providers.md
  • kite-chain/9-gasless-integration/README.md
  • kite-chain/3-developing/smart-contracts-list.md
  • integration-guide/workflow-overview.md
  • kite-chain/3-developing/setup-environment.md
  • README.md
  • kite-chain/1-getting-started/network-information.md

Comment thread get-started/README.md
Comment thread kite-agent-passport/README.md
Comment thread kite-agent-passport/service-provider-guide.md
@springzhang-kite springzhang-kite changed the title [do-not-merge] feat: add GitBook deprecation banner to every page feat: add GitBook deprecation banner to every page Jun 4, 2026
@springzhang-kite springzhang-kite merged commit ea4d84b into main Jun 4, 2026
6 checks passed
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