• Create folder /src/_store
  • Move /src/app/store.ts → /src/_store/index.ts
  • Move /src/_helpers/articlesSlice.ts → /src/_store/slices/articlesSlice.ts
  • Move /src/_helpers/settingsSlice.ts → /src/_store/slices/settingsSlice.ts
  • Move /src/components/SideNav/sideNavSlice.ts → /src/_store/slices/sideNavSlice.ts
• Create settingsMiddleware and startListening to any changes in settings
  • Move «save settings to localStorage» and «Synchronize NEXT_LOCALE cookie and settings.locale» logics to settingsMiddleware

• Order articles by the number at the beginning of filename
  Filename template: ${N}. ${articleName}.md
  Example: 1. Introduction.md

• Get article content by URL slug instead of filename

• Group articles by the 'groupName' YAML property
  If not specified, the article does not belong to any group
  Example:

  ---
  groupName: Appendix #This article belongs to 'Appendix' group
  ---

After pressing "Try again" button:

• Prefetch articles metadata

• #24

• Resolve locale manually in order from cookies()¹ or URL² or Accept-Language header³

• Synchronize NEXT_LOCALE cookie and settings.locale from localStorage

• Whenever a locale value is read from a cookie or localStorage, check if the locale is supported

https://nextjs.org/docs/app/building-your-application/routing/internationalization

Create standalone pure HTML page for providing all articles in one place without JavaScript

Features

• Provides all articles in one place
  • Supports articles' translations
• Works without JavaScript
• Uses the minimum amount of network traffic

• Fix max width of SideNav

Implement:

• Support export formats:
  • HTML
  • Markdown
• Export type
  • Current article
  • All articles in one file
  • All articles separated in ZIP archive
• Disable "Current Article" export option on non-article pages
• Add the ability to work offline for Export Modal

• Add important files to cache on first service worker install

  • /manifest.json?locale=${locale}¹
  • /offline

• Disable start URL caching

• Update /offline, /manifest.json?locale=${locale}¹ in cache on locale change

• Add to cache manifests for all locales, if settings.cacheLocales: 'all'

• Ask user to reload when a new service worker is installed²

• Exclude /api and files with extension from /offline fallback

• Handle 404 errors with not-found.tsx

• Handle errors with error.tsx³

• Check if CacheStorage is supported on the client side

Use Cypress library for tests

• Add E2E¹ for:
  • Locale detection
  • Settings changing
  • Export articles
  • Offline mode
    • With cached articles
    • Without cached articles
• Add component tests for:
  • ExportModal
  • Header
    • HeaderMenu
  • SideNav
    • SideNavMenu
    • SideNavMobile
  • ShareLinkModal
  • SWUpdate

• Fetch articles' metadata for selected locale on app loading
• Use fetched metadata for SideNav and SearchModal

• Generate manifest.json file dynamically
• Detect locale from URL
  Example: /manifest.json?locale=en
  • Use en locale by default

Add metadata for pages

Static Metadata¹

• /app/[locale]/offline/layout.tsx
• /app/[locale]/(articles)/settings/layout.tsx

Dynamic Metadata²

• /app/[locale]/(articles)/[[...article]]/page.tsx
• /app/[locale]/layout.tsx

Required Metadata Fields

• title
  • template (only for root layout)
  • default (only for root layout)
• description
• metadataBase (only for root layout)
• alternates³ - generate alternate URLs for each locale
• openGraph
  • title - copy of title without template
  • description - copy of description
  • url - url
  • siteName - localized site name
  • locale - current locale
  • images - generate dynamic images⁴
• robots⁵
• icons⁶ (only for root layout)
• themeColor - preferred color for current colorMode (only for root layout)
• manifest - URL with ?locale= search parameter (only for root layout)

Required manifest.json Fields⁷

• name
• short_name
• start_url
• display
• theme_color - copy of the theme_color from metadata
• background_color
• description - description of the app itself
• icons - copy of the icons form metadata
• screenshots⁸

Implement:

• Language changing
  • Fetching available locales
• Theme settings
• Font size settings
• Articles cache settings
  • Languages caching
  • Media caching

• Update README.md
• Add code of conduct
• Choose licence
• Set up a security police
• Create issue templates

• Export array of supported locales from /src/middleware.ts
• Use exported array in all components where only locale codes are required