The official documentation site for daily.dev - built with Docusaurus 3
This repository contains the comprehensive documentation for daily.dev, designed to help our community members get the most out of the platform. The documentation covers everything from getting started to advanced features and contribution guidelines.
- π Comprehensive Guides: Complete coverage of daily.dev features and functionality
- π Algolia Search: Fast, integrated search across all documentation
- π Dark/Light Mode: Theme toggle for comfortable reading
- π± Responsive Design: Optimized for all devices
- βοΈ Edit Links: Direct GitHub integration for community contributions
- π Fast Performance: Built with Docusaurus 3 for optimal speed
Our documentation site is optimized for speed and performance:
- Build Time: ~45 seconds (production build)
- Bundle Size: ~2.1MB (gzipped: ~580KB)
- Lighthouse Scores:
- π Performance: 95+
- βΏ Accessibility: 100
- π SEO: 100
- π‘ Best Practices: 100
- Node.js: v18.0 or higher
- npm: v7.0 or higher (or yarn/pnpm equivalent)
# Clone the repository
git clone https://github.com/dailydotdev/docs.git
cd docs
# Use correct Node version (if using nvm)
nvm use
# Install dependencies
npm install
# Start development server
npm start
The site will be available at http://localhost:3000
with hot reload enabled.
Command | Description |
---|---|
npm start |
Start development server |
npm run build |
Build for production |
npm run serve |
Serve built site locally |
npm run clear |
Clear Docusaurus cache |
npm run docker:compose |
Build and run with Docker Compose |
npm run docker:run |
Run pre-built Docker image |
docker compose up --build
docker run -p 3000:3000 francescoxx/dailydev-docs:0.9.3
Both methods serve the site on http://localhost:3000
.
Currently, the project uses the following quality assurance processes:
# Build test (validates all content can be built)
npm run build
# Link checking (validates all internal and external links)
npm run build && npm run serve # Manual verification recommended
# Markdown linting (if configured)
npm run lint # Check for linting scripts in package.json
- Content Validation: All markdown files are validated during build
- Link Validation: Internal links are checked during build process
- Performance Testing: Lighthouse CI can be run on built site
- Accessibility Testing: Built-in Docusaurus accessibility features
- SEO Validation: Meta tags and structured data are automatically generated
The project uses GitHub Actions for:
- Build Verification: Ensures all changes build successfully
- Link Checking: Validates all documentation links
- Performance Monitoring: Lighthouse scores on pull requests
- Automated Deployment: Builds and deploys to production
# Check for broken links locally
npm run build && npm run serve
# Then manually test critical pages
# Validate markdown formatting
# Use your preferred markdown linter or IDE extensions
# Performance testing
# Use browser dev tools or Lighthouse extension
This documentation site is built using modern web technologies:
- Docusaurus 3: Static site generator with React-based theming
- React 18: Component framework for interactive elements
- MDX: Markdown with JSX support for rich documentation
- Algolia Search: Fast, integrated search functionality
docs/
βββ docs/ # Documentation content (Markdown files)
βββ src/
β βββ components/ # React components
β βββ pages/ # Custom pages
β βββ css/ # Global styles
βββ static/ # Static assets (images, icons)
βββ docusaurus.config.js # Site configuration
βββ sidebars.js # Navigation structure
We welcome contributions from the community! Here's how you can help:
- Fork the repository
- Create a new branch for your changes
- Edit or add documentation in the
docs/
directory - Test your changes locally with
npm start
- Submit a pull request with a clear description
- Use GitHub Issues to report bugs or request features
- Provide detailed information and steps to reproduce
- Include screenshots when applicable
- Clear Documentation: Write clear, concise, and helpful content
- Consistent Style: Follow existing formatting and tone
- Test Changes: Ensure your changes work locally before submitting
- Descriptive PRs: Include meaningful commit messages and PR descriptions
Our review process ensures high-quality documentation:
- Automated Checks: All PRs trigger automated builds and link validation
- Content Review: Team members review for accuracy, clarity, and completeness
- Technical Review: Changes are tested locally and validated against live site
- Approval Requirements:
- At least one team member approval required
- All automated checks must pass
- No merge conflicts or failing builds
- Merge Timeline: Most PRs are reviewed within 48 hours during business days
Review Criteria:
- Content accuracy and helpfulness
- Consistent formatting and style
- Working links and references
- Mobile-friendly formatting
- SEO optimization (headings, meta descriptions)
Node version conflicts:
nvm use # Use the version specified in .nvmrc
npm list # Check installed packages
Port already in use:
npm start -- --port 3001 # Use a different port
lsof -ti:3000 | xargs kill -9 # Kill processes using port 3000
Build errors:
npm run clear # Clear Docusaurus cache
npm install # Reinstall dependencies
rm -rf node_modules package-lock.json && npm install # Clean reinstall
Memory issues during build:
NODE_OPTIONS="--max-old-space-size=4096" npm run build # Increase memory limit
Permission errors:
sudo chown -R $(whoami) ~/.npm # Fix npm permissions
npm cache clean --force # Clear npm cache
Algolia search not working:
# Check if ALGOLIA_APP_ID and ALGOLIA_API_KEY are set
npm run build # Search only works in production build
Hot reload not working:
npm run clear # Clear cache
npm start -- --no-minify # Disable minification
Docker build failures:
docker system prune -a # Clean Docker system
docker build --no-cache . # Build without cache
- Check existing Issues
- Visit daily.dev for general support
- Review Docusaurus troubleshooting for framework-specific issues
This project is licensed under the AGPL-3.0 License.
Made with β€οΈ by the daily.dev team and community
Website β’ Documentation β’ Twitter β’ LinkedIn
Don't forget to β this repository if you found it helpful!