Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Dec 31, 2025

The README contained two separate "read the docs" calls-to-action within a few lines of each other—a standalone heading followed by a TIP callout—creating redundant, potentially off-putting messaging.

Changes

  • Removed standalone ### [Read the docs →] heading before Introduction section
  • Enhanced TIP callout to consolidate both messages:
    • More direct CTA: "For the best experience with interactive type hints, read the docs →"
    • Explicit explanation: type hints available via hover in docs, not on GitHub
  • Updated both root and package READMEs consistently

Before/After

Before:

### [Read the docs →](https://arkenv.js.org/docs/arkenv)

## Introduction

> [!TIP]
> 📖 **Reading this on GitHub?** Check out [this page in our docs](...) to hover over code blocks and get type hints!

After:

## Introduction

> [!TIP]
> 📖 **For the best experience with interactive type hints, [read the docs →](...)**
>
> Hover over code in the docs to see exact types and get full editor-like feedback. GitHub's markdown viewer doesn't support this feature.

Single clear message, no repetition, better context for why users should visit the docs.

Original prompt

This section details on the original issue you should resolve

<issue_title>“Read the docs” comment repetitive/annoying</issue_title>
<issue_description>The “read the docs” comment in the README is a little repetitive which might be a turn off for some readers. Maybe the “introduction” start immediately and that note should be above it, or part of the huge “read the docs” link. It should be a “you better read the docs” sign that doesn’t repeat and ensures people are aware that type hints are only available there (so they’re not confused when they see comments like “hover to see this and that!”</issue_description>

Comments on the Issue (you are @copilot in this section)


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

@changeset-bot
Copy link

changeset-bot bot commented Dec 31, 2025

⚠️ No Changeset found

Latest commit: cbd0eaa

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 31, 2025

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


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

Copilot AI changed the title [WIP] Update README to improve 'read the docs' message Consolidate repetitive "read the docs" messaging in README Dec 31, 2025
Copilot AI requested a review from yamcodes December 31, 2025 06:54
@yamcodes
Copy link
Owner

Closing in favor of #679

@yamcodes yamcodes closed this Dec 31, 2025
@yamcodes yamcodes deleted the copilot/refactor-read-the-docs-message branch December 31, 2025 12:07
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.

“Read the docs” comment repetitive/annoying

2 participants