From 51cef3dfdba7135d6ed4fa86d44318d3d3f42ed8 Mon Sep 17 00:00:00 2001 From: "Charlize (OpenClaw)" Date: Mon, 23 Feb 2026 07:18:25 +0000 Subject: [PATCH] feat: add AEO (Answer Engine Optimization) resources Add machine-readable resources for AI agents and bots: - static/llms.txt: Concise platform overview following llms.txt spec - static/api/features.json: Structured JSON index of all features - static/robots.txt: Explicitly allow AI crawlers (GPTBot, Claude, etc.) - AGENTS.md: Instructions for AI agents working with the repo - docs/for-developers/: New section with integration guides These resources make it easier for AI agents to: - Understand daily.dev features and capabilities - Navigate documentation programmatically - Build integrations with the platform - Answer user questions about daily.dev accurately --- AGENTS.md | 103 ++++++++++++++++++++ docs/for-developers/_category_.json | 4 + docs/for-developers/index.md | 120 +++++++++++++++++++++++ static/api/features.json | 145 ++++++++++++++++++++++++++++ static/llms.txt | 73 ++++++++++++++ static/robots.txt | 33 ++++++- 6 files changed, 476 insertions(+), 2 deletions(-) create mode 100644 AGENTS.md create mode 100644 docs/for-developers/_category_.json create mode 100644 docs/for-developers/index.md create mode 100644 static/api/features.json create mode 100644 static/llms.txt diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..0ded89b --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,103 @@ +# AGENTS.md - AI Agent Instructions + +This file provides guidance for AI agents (Claude, GPT, Codex, etc.) working with the daily.dev documentation repository. + +## Repository Purpose + +This is the official documentation site for daily.dev, a professional network for developers. The docs cover platform features, guides, and community information. + +## Quick Reference + +| Resource | Location | +|----------|----------| +| Documentation content | `docs/` | +| Machine-readable overview | `static/llms.txt` | +| Feature index (JSON) | `static/api/features.json` | +| Site config | `docusaurus.config.js` | +| Sidebar structure | `sidebars.js` | + +## Documentation Structure + +``` +docs/ +├── getting-started/ # Installation guides +├── key-features/ # Core platform features +├── setting-up-your-feed/# Feed configuration +├── customize-your-feed/ # Visual customization +├── squads/ # Community features +├── plus/ # Premium features +├── monetization/ # Cores, awards, boost +├── organizations/ # Team features +├── your-profile/ # Profile management +├── career-mode/ # Job matching +└── for-content-creators/# Creator guidelines +``` + +## Common Tasks + +### Adding Documentation + +1. Create `.md` file in appropriate `docs/` subdirectory +2. Add frontmatter: + ```yaml + --- + sidebar_position: N + description: "Brief description for SEO and previews" + --- + ``` +3. Use proper heading hierarchy (H1 > H2 > H3) +4. Link related docs with relative paths: `[text](../category/page.md)` + +### Updating Feature Docs + +When documenting features, verify against: +- `dailydotdev/daily-api` - Backend implementation +- `dailydotdev/apps` - Frontend implementation + +Check what's actually shipped vs what's in code but not exposed. + +### Style Guidelines + +- **Tone**: Professional, clear, developer-friendly +- **Avoid**: Excessive emojis, marketing fluff, exclamation marks +- **Prefer**: Technical clarity, concrete examples, accurate information +- **Images**: Store in `static/img/`, use Cloudinary URLs for screenshots + +## API Documentation + +The Public API requires Plus subscription: +- Base URL: `https://api.daily.dev/public/v1` +- OpenAPI Spec: `https://api.daily.dev/public/v1/docs/json` +- Docs: `docs/plus/public-api.md` + +## Key Files for Agents + +### For Understanding the Platform +- `static/llms.txt` - Concise platform overview +- `static/api/features.json` - Structured feature index +- `docs/intro.md` - User-facing introduction + +### For Development +- `CLAUDE.md` - Claude-specific dev instructions +- `docusaurus.config.js` - Site configuration +- `package.json` - Dependencies and scripts + +## Verification Checklist + +Before submitting documentation changes: + +- [ ] Frontmatter includes sidebar_position and description +- [ ] Links use relative paths and work correctly +- [ ] Feature description matches current implementation +- [ ] No broken images or missing assets +- [ ] Tone is professional (see CLAUDE.md) + +## Related Repositories + +- `dailydotdev/daily-api` - Backend API +- `dailydotdev/apps` - Web and extension frontends +- `dailydotdev/daily` - Main monorepo + +## Contact + +For questions about documentation: open an issue or PR on this repository. diff --git a/docs/for-developers/_category_.json b/docs/for-developers/_category_.json new file mode 100644 index 0000000..67ea552 --- /dev/null +++ b/docs/for-developers/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "For Developers & AI", + "position": 100 +} diff --git a/docs/for-developers/index.md b/docs/for-developers/index.md new file mode 100644 index 0000000..a683a5a --- /dev/null +++ b/docs/for-developers/index.md @@ -0,0 +1,120 @@ +--- +sidebar_position: 100 +sidebar_label: For Developers & AI Agents +description: "Resources for developers building integrations and AI agents working with daily.dev - API access, machine-readable docs, and integration guides." +--- + +# For Developers & AI Agents + +This page provides resources for developers building integrations with daily.dev and AI agents that need to understand or interact with the platform. + +## Machine-Readable Resources + +| Resource | URL | Description | +|----------|-----|-------------| +| **llms.txt** | [/llms.txt](https://docs.daily.dev/llms.txt) | Concise platform overview for LLMs | +| **Feature Index** | [/api/features.json](https://docs.daily.dev/api/features.json) | Structured JSON index of all features | +| **OpenAPI Spec** | [api.daily.dev/public/v1/docs/json](https://api.daily.dev/public/v1/docs/json) | Full API specification | +| **Sitemap** | [/sitemap.xml](https://docs.daily.dev/sitemap.xml) | All documentation pages | + +## Public API + +The daily.dev Public API provides programmatic access to feeds, posts, bookmarks, and more. + +- **Requires**: [Plus subscription](../plus/plus-overview.md) +- **Base URL**: `https://api.daily.dev/public/v1` +- **Auth**: Bearer token (generate in [API Settings](https://app.daily.dev/settings/api)) + +[Full API Documentation →](../plus/public-api.md) + +### Quick Example + +```bash +curl -H "Authorization: Bearer $TOKEN" \ + "https://api.daily.dev/public/v1/feeds" +``` + +## AI Agent Integrations + +daily.dev provides skills/plugins for popular AI coding assistants: + +### Claude Code + +```bash +claude plugin marketplace add https://github.com/dailydotdev/daily.git +claude plugin install daily.dev@daily.dev +claude "/daily.dev setup" +``` + +### OpenClaw + +``` +Install the daily-dev skill from clawdhub and explain my new superpowers +``` + +Skill available at [clawhub.ai/idoshamun/daily-dev](https://clawhub.ai/idoshamun/daily-dev) + +### Codex + +``` +$skill-installer install the daily.dev skill from https://github.com/dailydotdev/daily.git +``` + +### Cursor + +1. Open Settings → Rules +2. Add Remote Rule from: `https://github.com/dailydotdev/daily.git` +3. Use `/daily.dev` in Agent chat + +## Repository Access + +For AI agents working with daily.dev codebases: + +| Repository | Purpose | +|------------|---------| +| [dailydotdev/docs](https://github.com/dailydotdev/docs) | This documentation site | +| [dailydotdev/apps](https://github.com/dailydotdev/apps) | Web app and browser extension | +| [dailydotdev/daily-api](https://github.com/dailydotdev/daily-api) | Backend API | + +Each repository includes: +- `CLAUDE.md` - Instructions for Claude/AI assistants +- `AGENTS.md` - General AI agent guidelines (where applicable) + +## Feature Discovery + +The [features.json](https://docs.daily.dev/api/features.json) file provides a structured index of all platform features, including: + +- Feature descriptions and documentation links +- API endpoints (where applicable) +- Capabilities and limitations +- Plus-only feature flags + +### Example: Checking if a feature requires Plus + +```javascript +const features = await fetch('https://docs.daily.dev/api/features.json').then(r => r.json()); + +if (features.features.smart_prompts.plus_only) { + console.log('Smart Prompts requires Plus subscription'); +} +``` + +## Rate Limits + +When using the API programmatically: + +| Limit Type | Rate | +|------------|------| +| IP-based | 300 requests/minute | +| User-based | 60 requests/minute | + +Check response headers for current limits: +- `x-ratelimit-limit` +- `x-ratelimit-remaining` +- `x-ratelimit-reset` + +## Support + +- **API Issues**: Open an issue on [dailydotdev/daily-api](https://github.com/dailydotdev/daily-api) +- **Documentation**: Open an issue on [dailydotdev/docs](https://github.com/dailydotdev/docs) +- **General Support**: support@daily.dev diff --git a/static/api/features.json b/static/api/features.json new file mode 100644 index 0000000..a430f2e --- /dev/null +++ b/static/api/features.json @@ -0,0 +1,145 @@ +{ + "$schema": "https://json-schema.org/draft/2020-12/schema", + "name": "daily.dev", + "description": "Professional network for developers with personalized content and community features", + "version": "2026.02", + "documentation": "https://docs.daily.dev", + "api": { + "base_url": "https://api.daily.dev/public/v1", + "openapi_spec": "https://api.daily.dev/public/v1/docs/json", + "requires": "Plus subscription", + "auth": "Bearer token" + }, + "features": { + "feeds": { + "description": "Personalized developer content streams", + "docs": "/docs/key-features/feeds", + "types": ["my-feed", "popular", "most-upvoted", "best-discussions", "custom"], + "api_endpoint": "/feeds" + }, + "squads": { + "description": "Developer communities for teams and interest groups", + "docs": "/docs/squads/creating-your-squad", + "capabilities": ["posts", "discussions", "moderation", "slack-integration", "stack-showcase"] + }, + "bookmarks": { + "description": "Save and organize posts", + "docs": "/docs/key-features/bookmarks", + "api_endpoint": "/bookmarks", + "plus_feature": "folders" + }, + "search": { + "description": "Find posts, tags, and sources", + "docs": "/docs/key-features/search", + "api_endpoint": "/search" + }, + "posts": { + "description": "Developer content articles and discussions", + "docs": "/docs/key-features/discussions", + "api_endpoint": "/posts", + "capabilities": ["upvote", "downvote", "comment", "bookmark", "share"] + }, + "smart_prompts": { + "description": "AI-powered interaction with posts", + "docs": "/docs/plus/smart-prompts", + "plus_only": true, + "prompts": ["simplify", "remove-fluff", "challenge", "practical-examples", "actionable-steps", "compare-alternatives", "custom"] + }, + "clickbait_shield": { + "description": "AI-optimized post titles", + "docs": "/docs/plus/clickbait-shield", + "plus_only": true + }, + "custom_feeds": { + "description": "Create filtered content streams", + "docs": "/docs/plus/custom-feeds", + "plus_only": true, + "api_endpoint": "/feeds" + }, + "notifications": { + "description": "Activity and content notifications", + "api_endpoint": "/notifications" + }, + "profile": { + "description": "User profile and settings", + "docs": "/docs/your-profile/account-details", + "api_endpoint": "/profile", + "features": ["stack-tools", "achievements", "devcard", "reading-streaks", "reputation"] + }, + "stack_tools": { + "description": "Showcase technologies and tools on profile", + "docs": "/docs/your-profile/stack-and-tools", + "sections": ["Primary", "Hobby", "Learning", "Past", "Custom"], + "limit": 100 + }, + "achievements": { + "description": "Milestones and progress tracking", + "types": ["instant", "streak", "milestone", "multipart"] + }, + "reading_streaks": { + "description": "Track daily reading habits", + "docs": "/docs/your-profile/weekly-goal", + "features": ["milestones", "weekend-freeze", "restore", "reminders"] + }, + "cores": { + "description": "In-app currency for rewards", + "docs": "/docs/monetization/cores", + "uses": ["awards", "tip-creators", "streak-restore"] + }, + "awards": { + "description": "Recognize content with stickers", + "docs": "/docs/monetization/awards" + }, + "career_mode": { + "description": "Privacy-first job matching", + "docs": "/docs/career-mode/overview", + "features": ["job-preferences", "profile-matching", "double-opt-in"] + } + }, + "integrations": { + "browser_extension": { + "description": "New tab replacement with daily.dev feed", + "docs": "/docs/getting-started/browser-extension-installation", + "platforms": ["chrome", "firefox", "edge"] + }, + "pwa": { + "description": "Progressive Web App", + "docs": "/docs/getting-started/pwa", + "url": "https://app.daily.dev" + }, + "slack": { + "description": "Squad notifications to Slack channels", + "docs": "/docs/squads/slack-integration" + }, + "ai_agents": { + "claude_code": { + "install": "claude plugin marketplace add https://github.com/dailydotdev/daily.git" + }, + "openclaw": { + "install": "Install the daily-dev skill from clawdhub" + }, + "codex": { + "install": "$skill-installer install the daily.dev skill from https://github.com/dailydotdev/daily.git" + }, + "cursor": { + "install": "Add remote rule from https://github.com/dailydotdev/daily.git" + } + } + }, + "content_types": { + "article": "External blog post or article", + "video": "YouTube or video content", + "freeform": "User-created post", + "collection": "Curated post collection", + "welcome": "Squad welcome post" + }, + "subscription_tiers": { + "free": { + "features": ["feeds", "bookmarks", "squads", "search", "discussions", "career-mode"] + }, + "plus": { + "features": ["smart-prompts", "clickbait-shield", "custom-feeds", "bookmark-folders", "keyword-filters", "public-api", "ad-free"], + "pricing_url": "https://app.daily.dev/plus" + } + } +} diff --git a/static/llms.txt b/static/llms.txt new file mode 100644 index 0000000..a927276 --- /dev/null +++ b/static/llms.txt @@ -0,0 +1,73 @@ +# daily.dev Documentation + +> daily.dev is a professional network for developers that aggregates tech content and provides community features. + +## Quick Links + +- Documentation: https://docs.daily.dev +- Main App: https://app.daily.dev +- API (Plus required): https://api.daily.dev/public/v1 +- OpenAPI Spec: https://api.daily.dev/public/v1/docs/json + +## Core Features + +- **Feeds**: Personalized developer content (My Feed, Popular, Most Upvoted, Best Discussions) +- **Squads**: Developer communities for teams and interest groups +- **Bookmarks**: Save and organize posts with folders (Plus) +- **Search**: Find posts, tags, and sources +- **Discussions**: Comment and engage on posts +- **Reputation**: Earn points through community contributions + +## Premium Features (Plus) + +- **Smart Prompts**: AI-powered interaction with posts +- **Clickbait Shield**: AI-cleaned titles +- **Custom Feeds**: Create filtered content streams +- **Public API**: Programmatic access to feeds and content +- **Keyword Filters**: Block unwanted content + +## Monetization + +- **Cores**: In-app currency for rewards +- **Awards**: Recognize great content with stickers +- **Boost**: Promote posts and Squads + +## Profile Features + +- **Stack & Tools**: Showcase your tech stack +- **Achievements**: Track milestones and progress +- **DevCard**: Shareable developer stats card +- **Reading Streaks**: Track daily reading habits + +## Career Mode + +- Privacy-first job matching for developers +- No recruiter spam, double opt-in process +- Free for developers + +## Getting Started + +- Browser Extension: https://daily.dev/download +- PWA: https://app.daily.dev + +## Documentation Sections + +- /docs/getting-started - Installation guides +- /docs/key-features - Core feature docs +- /docs/squads - Community features +- /docs/plus - Premium features +- /docs/your-profile - Profile management +- /docs/career-mode - Job matching +- /docs/monetization - Cores and awards +- /docs/for-content-creators - Creator guidelines + +## For AI Agents + +- Full docs: https://docs.daily.dev/llms-full.txt +- Feature index: https://docs.daily.dev/api/features.json +- OpenAPI spec: https://api.daily.dev/public/v1/docs/json + +## Contact + +- GitHub: https://github.com/dailydotdev +- Support: support@daily.dev diff --git a/static/robots.txt b/static/robots.txt index 85e6100..c7e0e39 100644 --- a/static/robots.txt +++ b/static/robots.txt @@ -1,9 +1,38 @@ +# robots.txt for docs.daily.dev + User-agent: * Allow: / # Sitemap location Sitemap: https://docs.daily.dev/sitemap.xml -# Block admin/build directories if they exist +# LLM/AI agent resources +# See https://docs.daily.dev/llms.txt for AI-friendly documentation overview +# See https://docs.daily.dev/api/features.json for structured feature index + +# Explicitly allow AI crawlers +User-agent: GPTBot +Allow: / + +User-agent: ChatGPT-User +Allow: / + +User-agent: Claude-Web +Allow: / + +User-agent: Anthropic-AI +Allow: / + +User-agent: CCBot +Allow: / + +User-agent: PerplexityBot +Allow: / + +User-agent: Bytespider +Allow: / + +# Block admin/build directories +User-agent: * Disallow: /admin/ -Disallow: /build/ \ No newline at end of file +Disallow: /build/