Changelog
Patch Changes
Section titled “Patch Changes”- c7e3402: Add new page “Build with AI” explaining how to integrate this Frontend Playbook with AI tools
- c5a7a82: Add new frontmatter property
isInLLMsto easily determine what should be included in llms.txt
Patch Changes
Section titled “Patch Changes”- b328e73: Extend the “Compound Component Pattern” page with explaining why and when to use it, link to patterns.dev article
- b328e73: Update “Reusability” section in “General Principles” - add AHA principle, explain why abstraction can sometimes hurt our code, add suggested rules
Major Changes
Section titled “Major Changes”- Migrate from a single plain .md file to Astro Starlight documentation site
Minor Changes
Section titled “Minor Changes”- Add section on using Type Guards and Parsing Data
- Implement
llms.txtandllms-full.txtfor better integration with AI tools - Extend introduction section
- Replace all links to Applifting TypeScript Starter template with a reference note
- Minor non-breaking tweaks and upgrades in several sections (updated links, wording, etc.)
-
ky HTTP client integration and style guide documentation
- Introduce best practices and usage patterns for HTTP requests using the ky package, emphasizing encapsulation with custom hooks and options for improved testability, maintainability, and reuse.
-
Public and private API client examples
- Document standardized patterns for creating both unauthenticated and authenticated API clients via ky, with examples for adding headers, prefix URLs, and retry logic.
-
Token refresh workflow using retry hooks
- Provide guidance on handling authentication, including automatic token refresh via beforeRetry hooks when encountering expired or invalid tokens.
-
TanStack Query integration tip
- Add notes on configuring TanStack Query to disable its automatic retries, avoiding double retry logic when used with ky.
Changed
Section titled “Changed”- Fix table of contents
- Immutability section
- update description
- provide better examples with gotchas
- Components section
- use arrow function for component definition unless you need hoisting
- Server State management section
- Explain why Apollo client is discouraged
- More in-depth explanation of encouraged patterns with Tanstack Query
- Better examples of Tanstack Query usage
- Better example of query keys factory pattern
- Environment variables section - just use T3 env
- Project structure section
- Next.js - change example to app router from pages router
- ESLint - enforce unidirectional codebase with forbidden cross-feature imports
- Naming functions section inside naming conventions
- API Types Generation suggested tooling and approach
- Routing section
- Encourage Tanstack Router
- Explain and provide examples of TS Router and TS Query integration
- Components section
- Encourage compound component pattern
- Project structure section
- General rules and explanations
- Flowchart explaining pages and features relation
- TanStack router example
- Escape hatch solution with checklist when to use it
- Coding section
- Common function rules
- Pure functions section
- Metadata frontmatter
Changed
Section titled “Changed”- Update section about explicit boolean conversion
- Allow and promote the double bang notation (
!!) as correct solution for boolean conversion
Changed
Section titled “Changed”- Fix links (table of content, eslint and prettier, typography example)
Changed
Section titled “Changed”- Add boolean conversion topic into coding section
Changed
Section titled “Changed”- Fix typos
- Use Conventional Comments as guidelines for MR feedback
Changed
Section titled “Changed”- Clarify the constant naming convention by renaming “Constants” to “Constants (primitives)“.
- Initial version of the style guide for frontend developers.
- Sections on:
- Introduction
- General Principles
- Project Structure
- Naming Conventions
- Components
- TypeScript
- Coding
- Static Code Analysis
- Documentation
- Contribution
- Environment Variables
- Preferred Libraries