Skip to content

Conversation

@MantisClone
Copy link
Member

@MantisClone MantisClone commented Nov 3, 2025

PR Description

Problem

The current banner message "🚀 New: Check out our revamped documentation!" doesn't adequately warn visitors that these beta docs are incomplete. Users may not realize that large sections (Release Notes, SDK tab, API Features, Use Cases) still contain AI slop or are mostly empty.

Proposed Solution

Replace the banner with a clear beta warning that:

  • States upfront that this is a work-in-progress
  • Highlights what's actually ready (Landing page, Webhooks, NEAR docs)
  • Warns about incomplete sections (Release Notes, SDK tab, API Features, Use Cases)
  • Provides escape route to stable docs at docs.request.network

Considerations

Banner remains dismissible so users actively working with beta content can hide it after first view.

Summary by CodeRabbit

  • Documentation
    • Updated documentation banner to communicate beta status, indicating which sections are ready (landing page, webhooks, NEAR docs) and which are under revision (release notes, SDK tab, API features, use cases), with a link to stable documentation for users preferring established content.

- Add clear beta warning indicating docs are work-in-progress
- Highlight completed sections: Landing page, Webhooks, NEAR docs
- Warn about incomplete sections: Release Notes, SDK tab, API Features, Use Cases
- Add link to stable docs at docs.request.network
@coderabbitai
Copy link

coderabbitai bot commented Nov 3, 2025

Walkthrough

The docs.json configuration file has been updated to replace the banner content message with a longer Beta Docs notification. The new message indicates which documentation sections are ready for use and which are undergoing revisions, with a link to stable documentation.

Changes

Cohort / File(s) Summary
Banner Content Update
docs.json
banner.content updated from "🚀 New: Check out our revamped documentation!" to a Beta Docs status message indicating readiness of Landing page, Webhooks, and NEAR docs, with notice that Release Notes, SDK tab, API Features, and Use Cases sections are still being revised.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

  • Verify the new banner message accurately reflects current documentation status
  • Confirm the link to stable docs is correct and accessible

Pre-merge checks and finishing touches

✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The pull request title 'chore: update beta banner with accurate work-in-progress warning' directly and specifically describes the main change in the changeset. The title clearly indicates that a banner is being updated with a work-in-progress warning, which aligns with the file-level summary showing the banner.content property being changed to a Beta Docs message. The title is concise, descriptive, and accurately reflects the primary objective of the PR.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch beta-banner

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 93aa02e and ff470da.

📒 Files selected for processing (1)
  • docs.json (1 hunks)
🔇 Additional comments (1)
docs.json (1)

34-34: Update accurately communicates beta status and addresses PR objectives.

The new banner message effectively conveys that docs are work-in-progress, specifies which sections are ready (Landing page, Webhooks, NEAR docs) and which are incomplete (Release Notes, SDK tab, API Features, Use Cases), and provides a clear link to stable documentation. The banner remains dismissible as intended.

Please verify the following before merging:

  1. Markdown rendering in Mintlify: Confirm that Mintlify's banner.content field renders markdown syntax (particularly the link [View stable docs →](...)) correctly in the banner UI. You can check the Mintlify documentation or test locally in a preview.

  2. URL correctness: Ensure https://docs.request.network points to the correct stable documentation site that users should fallback to.


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

@MantisClone MantisClone self-assigned this Nov 3, 2025
@MantisClone MantisClone marked this pull request as ready for review November 3, 2025 14:03
Copilot AI review requested due to automatic review settings November 3, 2025 14:03
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR updates the banner message in the documentation to communicate the current beta status and availability of different documentation sections to users.

  • Updated banner content from a generic announcement to a detailed beta status message
  • Added information about which documentation sections are complete and which are still in progress
  • Included a link to stable documentation for users who prefer the production-ready version

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@MantisClone MantisClone merged commit bcda71d into main Nov 3, 2025
10 checks passed
@MantisClone MantisClone deleted the beta-banner branch November 3, 2025 14:10
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