Skip to content

feat: add llms.txt for TweakCN #188

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Rishit30G
Copy link
Contributor

@Rishit30G Rishit30G commented Jul 25, 2025

What ?

This PR adds llms.txt for tweakcn.com

llms.txt is a standardized file format that helps AI assistants understand website's structure, tools, and resources at a glance.

It acts as a comprehensive index that enables LLMs to provide more accurate, specific recommendations and assistance when users ask about platform's capabilities.

More info at: https://llmstxt.org/

Generated via: https://www.gushwork.ai/llms-txt-generator

Screenshot

image

Summary by CodeRabbit

  • Documentation
    • Added a detailed overview of TweakCN’s features, theme categories, community themes, dashboard templates, pricing plans, and alternative access links in a new documentation file for easy reference.

Copy link

vercel bot commented Jul 25, 2025

@Rishit30G is attempting to deploy a commit to the tweakcn OSS program Team on Vercel.

A member of the Team first needs to authorize it.

Copy link

coderabbitai bot commented Jul 25, 2025

Walkthrough

A new documentation file, public/llms.txt, was introduced. This file outlines the features of TweakCN, a theme customization platform, detailing its tools, theme categories, collections, templates, pricing, and alternative access links. The content is organized with structured headings and bullet lists for clarity.

Changes

File(s) Change Summary
public/llms.txt Added documentation describing TweakCN platform features, theme categories, collections, pricing, and access links. No code changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

A new doc appears, crisp and neat,
Detailing themes both bold and sweet.
TweakCN’s features, now in view,
For anyone wanting a style that’s new.
With links and lists, all clear and bright—
This rabbit approves, it’s just right!
🐇✨

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@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: 1

🧹 Nitpick comments (2)
public/llms.txt (2)

61-62: Strip tracking parameters from public reference links

The utm_source query param in the alternative access URL exposes internal marketing data and is unnecessary for functionality. Prefer the clean link.

-62 - [Theme Customization Tool](https://tweakcn.com/?ref=shadcnregistry.com&utm_source=shadcnregistry.com): Access TweakCN through shadcn registry referral
+62 - [Theme Customization Tool](https://tweakcn.com/?ref=shadcnregistry.com): Access TweakCN through shadcn registry referral

1-63: Consider relocating to public/.well-known/llms.txt for broader ecosystem compatibility

Several crawlers default to /.well-known/llms.txt before trying the root path. A symbolic link or duplicate file there will improve discoverability with zero runtime cost.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 82c7d1e and 4cf3dad.

📒 Files selected for processing (1)
  • public/llms.txt (1 hunks)
🔇 Additional comments (1)
public/llms.txt (1)

1-3: Incorrect llms.txt header suggestion
The file already conforms to the official llms.txt spec: it begins with the required H1 project name (# TweakCN), includes the blockquote summary, optional detail paragraphs and lists, and then H2 sections (e.g. ## Core Tools). The spec explicitly forbids additional preambles or metadata headers before the project name, so no changes are needed here.

Likely an incorrect or invalid review comment.

Comment on lines +52 to +57
- [Intropic MUI Dashboard](https://tweakcn.com/themes/cmcxgdxz2000a04ilfi4b36bm): Dashboard template for managing subscriptions, revenue, and exercise goals
- [Subscription Management Dashboard](https://tweakcn.com/themes/cmd9a3wgy000204jm0av9ecot): Dashboard for managing subscriptions, revenue, and team collaboration
- [Subscription Management Dashboard](https://tweakcn.com/themes/cmc0csctl000i04jyfdcb35yt): Manage subscriptions, payments, and team collaboration effectively
- [App Management Dashboard](https://tweakcn.com/themes/cmdga4fyc000604l50mjpdyjv): Dashboard for managing subscriptions, revenue, and team collaboration
- [Subscription Management Dashboard](https://tweakcn.com/themes/cmdd1w2zm000204l7at2q5te4): Manage subscriptions, payments, and team collaboration effectively

Copy link

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Three near-identical “Subscription Management Dashboard” entries – remove duplicates or clarify differences

Lines 53–56 list the same dashboard name pointing to three different slugs; this makes it unclear whether they are different templates or copy-paste leftovers. Either rename them to unique template names or deduplicate.

-52 - [Intropic MUI Dashboard](https://tweakcn.com/themes/cmcxgdxz2000a04ilfi4b36bm): Dashboard template for managing subscriptions, revenue, and exercise goals
-53 - [Subscription Management Dashboard](https://tweakcn.com/themes/cmd9a3wgy000204jm0av9ecot): Dashboard for managing subscriptions, revenue, and team collaboration
-54 - [Subscription Management Dashboard](https://tweakcn.com/themes/cmc0csctl000i04jyfdcb35yt): Manage subscriptions, payments, and team collaboration effectively
-55 - [App Management Dashboard](https://tweakcn.com/themes/cmdga4fyc000604l50mjpdyjv): Dashboard for managing subscriptions, revenue, and team collaboration
-56 - [Subscription Management Dashboard](https://tweakcn.com/themes/cmdd1w2zm000204l7at2q5te4): Manage subscriptions, payments, and team collaboration effectively
+52 - [Intropic MUI Dashboard](https://tweakcn.com/themes/cmcxgdxz2000a04ilfi4b36bm): Manage subscriptions, revenue, and exercise goals
+53 - [Subscription Management Dashboard A](https://tweakcn.com/themes/cmd9a3wgy000204jm0av9ecot): Full-featured SaaS billing dashboard
+54 - [Subscription Management Dashboard B](https://tweakcn.com/themes/cmc0csctl000i04jyfdcb35yt): Lightweight Stripe-focused dashboard
+55 - [App Management Dashboard](https://tweakcn.com/themes/cmdga4fyc000604l50mjpdyjv): General app analytics & team collaboration
+56   <!-- removed duplicate entry -->

Committable suggestion skipped: line range outside the PR's diff.

🤖 Prompt for AI Agents
In public/llms.txt around lines 52 to 57, there are three entries named
"Subscription Management Dashboard" with different URLs, causing confusion about
whether they are distinct templates or duplicates. Review these entries to
determine if they represent unique dashboards; if so, rename each to a distinct,
descriptive name reflecting their differences. If they are duplicates, remove
the redundant entries to clarify the list.

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.

1 participant