Skip to content

Commit 3d7ab12

Browse files
nimrodkraclaude
andauthored
docs: improve documentation professionalism and add llm.txt (#490)
Comprehensive review and improvements across all documentation: - Remove 40+ emojis from headings and content for professional tone - Replace casual language with clear, technical documentation style - Eliminate marketing phrases and promotional language - Fix typos (Clickbait Sheild → Shield) - Standardize heading structures for consistency - Remove unnecessary exclamation marks and motivational phrases - Replace slang terms with professional alternatives - Change "Bullshit Police" to "Critical Analysis" Add llm.txt file: - Comprehensive AI-readable project documentation - Complete project structure and file organization - Technology stack and development workflow - Content guidelines and conventions - 10KB reference document for LLM context 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-authored-by: Claude <noreply@anthropic.com>
1 parent 5e21033 commit 3d7ab12

28 files changed

Lines changed: 378 additions & 93 deletions

docs/customize-your-feed/layout.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,15 @@ To switch between Grid and List mode, click on the **customize** option from the
1111

1212
![Switch from List to Grid mode on daily.dev](https://daily-now-res.cloudinary.com/image/upload/v1724400818/docs-v2/a57d8ba8-dbfb-4407-9759-fbf9dc1154a6.png)
1313

14-
## Grid Mode for Content Display
14+
## Grid Mode
1515

1616
The **Grid mode** displays posts as cards arranged in a grid format, as seen in the image below:
1717

1818
![Grid mode view for daily.dev feed](https://daily-now-res.cloudinary.com/image/upload/v1724400852/docs-v2/a6b59df0-78b5-431a-8719-1efb654f9ef4.png)
1919

2020
In Grid mode, posts are positioned both vertically and horizontally, making it easy to scan and interact with the content. Grid mode adapts seamlessly to various viewports and orientations, providing consistency across different platforms and screen sizes.
2121

22-
## List Mode for Simplified Layout
22+
## List Mode
2323

2424
In **List mode**, posts are stacked vertically in a list, as shown below:
2525

docs/for-content-creators/claiming-ownership-on-article.md

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,25 +7,21 @@ description: "Discover special features for content creators on daily.dev, inclu
77

88
## Who is This Guide For?
99

10-
✏️ Do you write blog posts for developers?
10+
Do you write blog posts for developers?
1111

12-
🔭 Have you seen your blog post picked up by the daily.dev feed?
12+
Have you seen your blog post picked up by the daily.dev feed?
1313

14-
🚗 Are you curious about how much traffic your post received through daily.dev?
14+
Are you curious about how much traffic your post received through daily.dev?
1515

16-
👽 Do you believe in UFOs? Just kidding.
17-
18-
If you answered yes to the first three questions, this guide is for you!
16+
If you answered yes to these questions, this guide is for you!
1917

2018
## Introducing New Features for Content Creators
2119

22-
In this guide, we will cover:
23-
24-
1. Why claim ownership of posts you’ve written?
25-
2. How to claim ownership of your posts.
26-
3. How to get your content featured on daily.dev.
20+
This guide covers:
2721

28-
Let’s get started! 🚀
22+
1. Why claim ownership of posts you've written
23+
2. How to claim ownership of your posts
24+
3. How to get your content featured on daily.dev
2925

3026
## Why Claim Ownership of a Post You Wrote?
3127

docs/for-content-creators/content-guidelines.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Aligning your content with our standards enhances our community’s quality and
3333

3434
✅ Clear distinction between sponsored and editorial content.
3535

36-
Positive and professional vibes ✌️
36+
Professional and constructive content
3737

3838
:::info
3939
To maintain a balanced content inventory, we’re temporarily prioritizing niche sources. This helps us provide diverse and unique topics for our developer community. Mainstream content may be subject to more rigorous review to ensure a balanced mix.

docs/getting-started/browser-extension-installation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: "Install the daily.dev browser extension for a seamless browsing ex
55

66
# Browser Extension Installation Guide for daily.dev
77

8-
The daily.dev browser extension is a powerful tool to enhance your daily.dev experience. It allows daily.dev to show up in a new tab, helping you develop a daily reading habit. Don't worry, you can easily [pause the new tab behavior on daily.dev](/key-features/pause-new-tab.md) whenever you want! Additionally, the extension provides access to [the companion widget for daily.dev](/key-features/the-companion.md) for added convenience.
8+
The daily.dev browser extension is a powerful tool to enhance your daily.dev experience. It allows daily.dev to show up in a new tab, helping you develop a daily reading habit. You can [pause the new tab behavior on daily.dev](/key-features/pause-new-tab.md) at any time. Additionally, the extension provides access to [the companion widget for daily.dev](/key-features/the-companion.md) for added convenience.
99

1010
## Supported Browsers for daily.dev
1111

@@ -19,7 +19,7 @@ You can install the daily.dev extension on the following browsers:
1919
We’ve had to temporarily remove the Firefox extension from the store due to the Mozilla review team’s decision to enforce certain terms. These terms include changes that are partially non-feasible and not reasonable for any app developer to implement, affecting our ability to operate and monetize the app. As a result, Mozilla reverted our extension to an outdated version, making it unusable. We are actively working to find a resolution and appreciate your understanding and patience.
2020
:::
2121

22-
Just install the extension, open a new tab, and you're all set!
22+
Install the extension and open a new tab to begin.
2323

2424
## Using Alternative Browsers?
2525

docs/getting-started/pwa.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: "Explore the daily.dev Progressive Web App (PWA) for a seamless, cr
55

66
# Progressive Web App (PWA) for daily.dev
77

8-
Experience daily.dev like never before with our fully responsive and user-friendly **progressive web app (PWA)**! Stay up-to-date with the latest developer news, tips, and insights on any device, anytime, anywhere. Read on to learn how you can add a shortcut to your home screen on iOS and Android for quick access to the daily.dev PWA!
8+
Access daily.dev through our fully responsive and user-friendly **progressive web app (PWA)**. Stay up-to-date with the latest developer news, tips, and insights on any device, anytime, anywhere. This guide explains how to add a shortcut to your home screen on iOS and Android for quick access to the daily.dev PWA.
99

1010
All you need to do is visit [this URL to access daily.dev on any device](https://app.daily.dev).
1111

docs/intro.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ daily.dev is a professional network for developers that brings the latest tech n
1414

1515
Get the most out of daily.dev with this step-by-step guide to set up your personalized developer experience.
1616

17-
### Step 1: Choose Your Platform 🚀
17+
### Step 1: Choose Your Platform
1818

1919
**Browser Extension** (Recommended)
2020
- Install the [browser extension](getting-started/browser-extension-installation) for Chrome or Edge
@@ -26,15 +26,15 @@ Get the most out of daily.dev with this step-by-step guide to set up your person
2626
- [Progressive Web App (PWA)](getting-started/pwa) for Firefox, Safari, and other browsers
2727
- [Android app](https://play.google.com/store/apps/details?id=dev.daily) on Google Play Store
2828

29-
### Step 2: Set Up Your Personal Feed 🎯
29+
### Step 2: Set Up Your Personal Feed
3030

3131
Create a customized feed that delivers the most relevant content:
3232

3333
1. **Filter by interests**: [Set up your feed](setting-up-your-feed/filtering-content-feed) with tags that match your tech interests
3434
2. **Fine-tune content**: Use [advanced filtering options](setting-up-your-feed/advanced-filtering-options) to control content types
3535
3. **Remove noise**: [Block unwanted tags and sources](setting-up-your-feed/blocking-tags-sources) to focus on what matters
3636

37-
### Step 3: Explore Different Feeds 📖
37+
### Step 3: Explore Different Feeds
3838

3939
Discover content through multiple feed types:
4040

@@ -45,7 +45,7 @@ Discover content through multiple feed types:
4545

4646
Learn more about [how feeds work](key-features/feeds).
4747

48-
### Step 4: Join the Community & Squads 👥
48+
### Step 4: Join the Community & Squads
4949

5050
Build your presence and connect with other developers through our vibrant community features:
5151

@@ -58,7 +58,7 @@ Build your presence and connect with other developers through our vibrant commun
5858
**Why Squads Matter:**
5959
Squads are the heart of daily.dev's community experience. Whether you're interested in React, AI, DevOps, or career advice, there's likely a Squad for you. These focused communities allow for deeper discussions, knowledge sharing, and networking with like-minded developers.
6060

61-
### Step 5: Customize Your Experience 🌈
61+
### Step 5: Customize Your Experience
6262

6363
Make daily.dev work exactly how you want:
6464

@@ -68,13 +68,13 @@ Make daily.dev work exactly how you want:
6868

6969
## Key Features to Explore
7070

71-
- 🔍 **[Search](key-features/search)**: Find specific content across all sources
72-
- 💬 **[Discussions](key-features/discussions)**: Engage in meaningful conversations
73-
- 🗳️ **[Polls](key-features/polls)**: Gather community opinions with interactive voting
74-
- 👥 **[Squads](squads/creating-your-squad)**: Join or create developer communities around shared interests - the heart of daily.dev's community experience with specialized groups for technologies like React, AI, DevOps, and more
75-
- 📱 **[The Companion](key-features/the-companion)**: Quick access widget for seamless browsing
71+
- **[Search](key-features/search)**: Find specific content across all sources
72+
- **[Discussions](key-features/discussions)**: Engage in meaningful conversations
73+
- **[Polls](key-features/polls)**: Gather community opinions with interactive voting
74+
- **[Squads](squads/creating-your-squad)**: Join or create developer communities around shared interests - the heart of daily.dev's community experience with specialized groups for technologies like React, AI, DevOps, and more
75+
- **[The Companion](key-features/the-companion)**: Quick access widget for seamless browsing
7676

77-
## Ready to Level Up?
77+
## Premium Features Available
7878

7979
Explore [daily.dev Plus](plus/plus-overview) for premium features including:
8080
- AI-powered clean titles (Clickbait Shield)
@@ -86,6 +86,6 @@ Explore [daily.dev Plus](plus/plus-overview) for premium features including:
8686

8787
## Join the Community
8888

89-
Ready to connect with fellow developers? **Squads** are where the magic happens - join existing communities or [create your own Squad](squads/creating-your-squad) to build meaningful connections around the technologies and topics you care about most.
89+
Ready to connect with fellow developers? **Squads** are specialized communities where you can join existing groups or [create your own Squad](squads/creating-your-squad) to build meaningful connections around the technologies and topics you care about most.
9090

91-
Start your journey with daily.dev and join thousands of developers staying ahead in tech!
91+
Start your journey with daily.dev and join thousands of developers staying ahead in tech.

docs/key-features/bookmarks.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: "Learn how to save, organize, and sync daily.dev bookmarks across d
55

66
# Bookmarks
77

8-
## Importance of Bookmarks
8+
## Overview
99

1010
Bookmarks on **daily.dev** allow you to save and organize posts for later reading, helping you manage valuable content at your own pace.
1111

@@ -28,7 +28,7 @@ These methods ensure a seamless bookmarking experience in daily.dev.
2828

2929
## Bookmark reminder
3030

31-
Once you bookmark a post, you might see it on your feed as a reminder to read it!
31+
Once you bookmark a post, you may see it in your feed as a reminder to read it.
3232

3333
![Bookmark reminder image](https://github.com/user-attachments/assets/30f793c0-a1d2-469f-9f5c-f0249c257676)
3434

docs/key-features/discussions.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ description: "Engage in discussions on daily.dev to share insights, connect with
77

88
## What is a discussion?
99

10-
Discussions are a valuable way to engage with the professional developer community on daily.dev and share insights on various topics!
10+
Discussions are a valuable way to engage with the professional developer community on daily.dev and share insights on various topics.
1111

1212
As a professional network for developers, we highly value the opportunity for our community members to participate in public discussions. Discussions allow you to share your thoughts, insights, and experiences related to a post or topic and contribute to the community's collective knowledge.
1313

@@ -27,7 +27,7 @@ Participating in discussions can benefit you in several ways:
2727

2828
Click on any post in the feed to see the post modal.
2929

30-
Beneath the title, TLDR (Now powered by Open AI!), and post image, you can see all the comments on the post.
30+
Beneath the title, TLDR (powered by OpenAI), and post image, you can see all the comments on the post.
3131

3232
You can upvote, downvote, comment, bookmark, and copy the link.
3333

@@ -51,7 +51,7 @@ You can then leave a comment [using markdown](#writing-comments-in-markdown) in
5151

5252
### Writing comments in markdown
5353

54-
You can [use markdown](https://www.markdownguide.org/cheat-sheet/) when commenting on posts 🎉
54+
You can [use markdown](https://www.markdownguide.org/cheat-sheet/) when commenting on posts.
5555

5656
Including:
5757
* Headings (using `#` for a h1 through to `######` for a h6 )

docs/key-features/feeds.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@ Prefer a video version? Check out this 6-minute video that explains each feed in
1818

1919
## My feed
2020

21-
Your feed contains posts that are relevant to you and your interests (once you have set it up).
21+
Your feed contains posts that are relevant to your interests after you configure your preferences.
2222

2323
### Creating your personal feed
2424

25-
If you are new to daily.dev, the first thing we strongly recommend is setting up filters on your feed. This will unlock the true power of daily.dev, showing posts that are relevant to your interests.
25+
For new users, we recommend configuring feed filters to personalize your content. This enables personalized content recommendations based on your interests.
2626

2727
There are three guides to help you get the most out of your feed:
2828
1. A detailed guide on how to [set up your feed](/docs/setting-up-your-feed/filtering-content-feed).
@@ -81,4 +81,4 @@ There are three options (6):
8181

8282
## Best discussions feed
8383

84-
In the "Best Discussions" feed, we showcase the most interesting discussions currently taking place on daily.dev. The ranking is determined by multiple factors, including the reputation levels of the people who commented, the freshness of the comments, and the number of upvotes on the comments, among others. This feed is designed to help you find engaging and interesting discussions that you can participate in!
84+
In the "Best Discussions" feed, we showcase the most interesting discussions currently taking place on daily.dev. The ranking is determined by multiple factors, including the reputation levels of the people who commented, the freshness of the comments, and the number of upvotes on the comments, among others. This feed is designed to help you find engaging and interesting discussions that you can participate in.

docs/key-features/pause-new-tab.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: "Learn how to use the Pause New Tab (Do Not Disturb) feature on dai
55

66
# Pause New Tab (DND)
77

8-
At daily.dev, we understand that sometimes you need to focus without distractions. While our new tab functionality is designed to provide you with interesting posts, we also recognize that there may be times when you need to temporarily disable it. That's why we've introduced the "Pause New Tab" (Do Not Disturb) feature.
8+
The "Pause New Tab" (Do Not Disturb) feature allows you to temporarily disable the new tab functionality when you need to focus without distractions.
99

1010
## Activating Pause New Tab Mode
1111

0 commit comments

Comments
 (0)