shiplog 0.1.1 → 0.3.0

data/config/locales/en.yml

@@ -19,6 +19,18 @@ en:
     roadmap:
       title: Roadmap
       lede: What we're working on and what comes next.
+      parts:
+        one: Includes %{count} part
+        other: Includes %{count} parts
+      shipped_heading: Recently shipped
+      shipped_date_format: "%-d %B"
+      full_changelog: See the full changelog
+      footnote: ""
+      suggest: Suggest a feature
+    switcher:
+      label: Product updates
+      roadmap: Roadmap
+      changelog: Changelog
     changelog:
       title: Changelog
       lede: New features and improvements, as they ship.
@@ -26,12 +38,69 @@ en:
         label: Pagination
         older: Older
         newer: Newer
+      search:
+        label: Search the changelog
+        submit: Search
+        summary:
+          one: "%{count} result for “%{query}”"
+          other: "%{count} results for “%{query}”"
+        clear: Clear search
+        empty: "No entries match “%{query}”."
+      areas:
+        label: Filter by area
+        all: All
+    permalink:
+      title: "%{title} · %{changelog}"
+      back: "← Back to the changelog"
+      nav_label: More changelog entries
+      newer: "← Newer: %{title}"
+      older: "Older: %{title} →"
+    feed:
+      title_with_product: "%{product} changelog"
+      link_title: Changelog (Atom)
+      subscribe: Subscribe (Atom)
     admin:
       title: Shiplog admin
       nav:
         drafts: Drafts
         board: Roadmap board
         sync: Sync
+        areas: Areas
+      areas:
+        title: Product areas
+        help: The AI groups entries into areas (at most %{max}) while it rewrites them. Visitors can filter the changelog by area once two areas have published entries.
+        detect: Detect areas
+        recheck: Re-check unplaced entries
+        recheck_help: Ask the AI again about entries it left without an area, e.g. after renaming, merging or adding areas.
+        no_rewriter: Detection needs config.rewriter, which is not set.
+        last_detection: "Last detection: %{time}, assigned %{count}"
+        last_error: "Last detection failed (%{time}): %{error}"
+        detection_queued: Detection queued. Refresh in a moment.
+        translate_names: Translate names
+        translate_names_help: Ask the AI for the names that are missing in some language. Names that are already there, including ones you edited, are kept.
+        no_locales: Translating names needs config.locales, which is empty.
+        no_rewriter_translate: Translating names needs config.rewriter, which is not set.
+        translation_queued:
+          one: Translation queued for %{count} area. Refresh in a moment.
+          other: Translation queued for %{count} areas. Refresh in a moment.
+        empty: No areas yet. Detect areas to propose some from your entries.
+        columns:
+          name: Name
+          entries: Entries
+          order: Order
+          merge: Merge into
+        name_label: Name
+        rename: Rename
+        renamed: Area renamed.
+        move_up: Move up
+        move_down: Move down
+        merge: Merge
+        merge_into: Merge into
+        merged: "%{from} merged into %{into}."
+        merge_target: Choose another area to merge into.
+        merge_help: Merging moves the entries to the other area and deletes this one. Deleting an area leaves its entries without one.
+        delete: Delete
+        deleted: Area deleted. Its entries have no area now.
       entries:
         title: Entries
         filters: Filter entries
@@ -53,6 +122,8 @@ en:
         restore: Restore
         save: Save
         regenerate: Regenerate
+        no_area: None
+        area_gone: no longer exists
         regenerate_warning: Regenerating unpublishes this entry until re-approved.
         source_changed: GitHub text changed since this draft
         rewrite_error: Rewrite failed
@@ -60,6 +131,39 @@ en:
         public_text: Public text
         source: GitHub source
         back: Back to drafts
+        images:
+          title: Screenshots
+          help: Shown under the text on the changelog (the first one in the list, all of them on the entry's page). Taken from the GitHub issue or pull request when the draft is written; you can also upload your own.
+          empty: No screenshots yet.
+          alt: Alt text
+          alt_placeholder: Describe the image (defaults to the title)
+          save_alt: Save alt text
+          remove: Remove
+          move_up: Up
+          move_down: Down
+          upload: Upload images
+          upload_label: Images (PNG, JPEG, GIF or WebP, up to 5 MB each)
+          none_selected: Choose at least one image.
+          rejected: "Not added, only PNG, JPEG, GIF and WebP images up to 5 MB and 10,000 pixels a side are accepted: %{names}"
+          added:
+            one: Image added.
+            other: "%{count} images added."
+          alt_saved: Alt text saved.
+          removed: Image removed.
+          moved: Image moved.
+        translations:
+          title: Translations
+          help: "Approving an entry translates it automatically, and the translation is published with the English text. A translation you edit is kept until the English text changes; then it is translated again. A stale or missing translation is not shown: visitors see the English text."
+          not_approved: Translations are written when the entry is approved.
+          missing: Missing
+          stale: Stale
+          current: Up to date
+          edited: Edited by an admin
+          retranslate: Retranslate
+          saved: Translation saved.
+          queued: Translation queued. Refresh in a moment.
+          only_approved: Only approved entries are translated.
+          no_rewriter: Translating needs config.rewriter, which is not set.
         category_options:
           feature: New feature
           change: Improvement
@@ -81,6 +185,7 @@ en:
           body: Text
           released_on: Released on
           category: Category
+          area: Area
           reason: Reason
       board:
         title: Roadmap board

data/config/locales/es.yml

@@ -0,0 +1,223 @@
+# Textos de Shiplog en español. Los hosts pueden sobrescribir cualquier clave en sus propios archivos de idioma.
+es:
+  activerecord:
+    attributes:
+      shiplog/entry:
+        changelog_kind: Categoría
+  # Los nombres de los meses que usa el formato de fecha de Shiplog (rails-i18n los trae también; son los mismos).
+  date:
+    month_names: [~, enero, febrero, marzo, abril, mayo, junio, julio, agosto, septiembre, octubre, noviembre, diciembre]
+  shiplog:
+    columns:
+      in_progress: En desarrollo
+      coming_soon: Próximamente
+      later: Más adelante
+      in_progress_description: Lo que estamos construyendo ahora
+      coming_soon_description: Lo siguiente en la lista
+      later_description: En nuestro radar
+    categories:
+      feature: Nuevo
+      change: Mejorado
+    empty: Todavía no hay nada
+    date_format: "%-d de %B de %Y"
+    roadmap:
+      title: Hoja de ruta
+      lede: En qué estamos trabajando y qué viene después.
+      parts:
+        one: Incluye %{count} parte
+        other: Incluye %{count} partes
+      shipped_heading: Lanzado recientemente
+      shipped_date_format: "%-d de %B"
+      full_changelog: Ver el registro de cambios completo
+      footnote: ""
+      suggest: Sugerir una función
+    switcher:
+      label: Actualizaciones del producto
+      roadmap: Hoja de ruta
+      changelog: Registro de cambios
+    changelog:
+      title: Registro de cambios
+      lede: Nuevas funciones y mejoras, a medida que se lanzan.
+      pagination:
+        label: Paginación
+        older: Anteriores
+        newer: Más recientes
+      search:
+        label: Buscar en el registro de cambios
+        submit: Buscar
+        summary:
+          one: "%{count} resultado para “%{query}”"
+          other: "%{count} resultados para “%{query}”"
+        clear: Borrar búsqueda
+        empty: "Ninguna entrada coincide con “%{query}”."
+      areas:
+        label: Filtrar por área
+        all: Todas
+    permalink:
+      title: "%{title} · %{changelog}"
+      back: "← Volver al registro de cambios"
+      nav_label: Más cambios
+      newer: "← Más reciente: %{title}"
+      older: "Anterior: %{title} →"
+    feed:
+      title_with_product: "Registro de cambios de %{product}"
+      link_title: Registro de cambios (Atom)
+      subscribe: Suscribirse (Atom)
+    admin:
+      title: Administración de Shiplog
+      nav:
+        drafts: Borradores
+        board: Tablero de la hoja de ruta
+        sync: Sincronización
+        areas: Áreas
+      areas:
+        title: Áreas del producto
+        help: La IA agrupa las entradas en áreas (como máximo %{max}) mientras las reescribe. Los visitantes pueden filtrar el registro de cambios por área cuando hay dos áreas con entradas publicadas.
+        detect: Detectar áreas
+        recheck: Revisar de nuevo las entradas sin área
+        recheck_help: Vuelve a preguntar a la IA por las entradas que dejó sin área, por ejemplo después de renombrar, fusionar o añadir áreas.
+        no_rewriter: La detección necesita config.rewriter, que no está configurado.
+        last_detection: "Última detección: %{time}, %{count} asignadas"
+        last_error: "La última detección falló (%{time}): %{error}"
+        detection_queued: Detección en cola. Actualiza en un momento.
+        translate_names: Traducir nombres
+        translate_names_help: Pide a la IA los nombres que faltan en algún idioma. Los nombres que ya existen, incluidos los que editaste, se conservan.
+        no_locales: Traducir los nombres necesita config.locales, que está vacío.
+        no_rewriter_translate: Traducir los nombres necesita config.rewriter, que no está configurado.
+        translation_queued:
+          one: Traducción en cola para %{count} área. Actualiza en un momento.
+          other: Traducción en cola para %{count} áreas. Actualiza en un momento.
+        empty: Todavía no hay áreas. Detecta áreas para que se propongan a partir de tus entradas.
+        columns:
+          name: Nombre
+          entries: Entradas
+          order: Orden
+          merge: Fusionar con
+        name_label: Nombre
+        rename: Renombrar
+        renamed: Área renombrada.
+        move_up: Subir
+        move_down: Bajar
+        merge: Fusionar
+        merge_into: Fusionar con
+        merged: "%{from} se fusionó con %{into}."
+        merge_target: Elige otra área con la que fusionar.
+        merge_help: Al fusionar, las entradas pasan a la otra área y esta se elimina. Si eliminas un área, sus entradas se quedan sin área.
+        delete: Eliminar
+        deleted: Área eliminada. Sus entradas ya no tienen área.
+      entries:
+        title: Entradas
+        filters: Filtrar entradas
+        all_kinds: Todos los tipos
+        empty: Ninguna entrada coincide.
+        pagination: Paginación
+        older: Anteriores
+        newer: Más recientes
+        saved: Entrada guardada.
+        approved: Entrada aprobada.
+        discarded: Entrada descartada.
+        restored: Entrada devuelta a borrador.
+        invalid_transition: Esa acción no está disponible para esta entrada en su estado actual.
+        rewrite_queued: Reescritura en cola. Actualiza en un momento.
+        edit: Editar
+        edit_title: "Editar %{kind}"
+        approve: Aprobar
+        discard: Descartar
+        restore: Restaurar
+        save: Guardar
+        regenerate: Regenerar
+        no_area: Ninguna
+        area_gone: ya no existe
+        regenerate_warning: Al regenerar, esta entrada deja de estar publicada hasta que se apruebe de nuevo.
+        source_changed: El texto de GitHub cambió desde este borrador
+        rewrite_error: Falló la reescritura
+        not_rewritten: Todavía sin reescribir
+        public_text: Texto público
+        source: Origen en GitHub
+        back: Volver a los borradores
+        images:
+          title: Capturas de pantalla
+          help: Se muestran bajo el texto en el registro de cambios (la primera en la lista, todas en la página de la entrada). Se toman de la incidencia o del pull request de GitHub al escribir el borrador; también puedes subir las tuyas.
+          empty: Todavía no hay capturas.
+          alt: Texto alternativo
+          alt_placeholder: Describe la imagen (por defecto, el título)
+          save_alt: Guardar texto alternativo
+          remove: Quitar
+          move_up: Subir
+          move_down: Bajar
+          upload: Subir imágenes
+          upload_label: Imágenes (PNG, JPEG, GIF o WebP, hasta 5 MB cada una)
+          none_selected: Elige al menos una imagen.
+          rejected: "No se añadieron; solo se aceptan imágenes PNG, JPEG, GIF y WebP de hasta 5 MB y 10.000 píxeles por lado: %{names}"
+          added:
+            one: Imagen añadida.
+            other: "%{count} imágenes añadidas."
+          alt_saved: Texto alternativo guardado.
+          removed: Imagen quitada.
+          moved: Imagen movida.
+        translations:
+          title: Traducciones
+          help: "Al aprobar una entrada, esta se traduce automáticamente, y la traducción se publica junto con el texto en inglés. Una traducción que edites se conserva hasta que cambie el texto en inglés; entonces se vuelve a traducir. Una traducción desactualizada o ausente no se muestra: los visitantes ven el texto en inglés."
+          not_approved: Las traducciones se escriben cuando se aprueba la entrada.
+          missing: Falta
+          stale: Desactualizada
+          current: Al día
+          edited: Editada por un administrador
+          retranslate: Traducir de nuevo
+          saved: Traducción guardada.
+          queued: Traducción en cola. Actualiza en un momento.
+          only_approved: Solo se traducen las entradas aprobadas.
+          no_rewriter: Para traducir hace falta config.rewriter, que no está configurado.
+        category_options:
+          feature: Nueva función
+          change: Mejora
+        statuses:
+          draft: Borradores
+          approved: Aprobadas
+          discarded: Descartadas
+        kinds:
+          roadmap: Hoja de ruta
+          feature: Función
+          change: Cambio
+        columns:
+          entry: Entrada
+          kind: Tipo
+          source: Origen
+          actions: Acciones
+        fields:
+          title: Título
+          body: Texto
+          released_on: Fecha de lanzamiento
+          category: Categoría
+          area: Área
+          reason: Motivo
+      board:
+        title: Tablero de la hoja de ruta
+        help: Arrastra las tarjetas entre columnas para fijarlas y ordenarlas. Sin JavaScript, usa el botón Mover de cada tarjeta.
+        updated: Tablero actualizado.
+        not_approved: Sin aprobar
+        pinned: Fijada
+        move_to: Mover a
+        move: Mover
+        unpin: Quitar de fijadas
+      sync:
+        title: Estado de la sincronización
+        queued: Sincronización en cola.
+        webhook_secret_missing: El secreto del webhook no está configurado, así que se rechazan los webhooks de GitHub.
+        github_token_missing: El token de GitHub no está configurado, así que no se puede sincronizar.
+        sync_now: Sincronizar ahora
+        sync_and_scan: Sincronizar y buscar cambios
+        repositories: Repositorios
+        no_repositories: No hay repositorios configurados.
+        repository: Repositorio
+        synced_at: Última sincronización
+        changes_scanned_at: Cambios revisados
+        last_error: Último error
+        never: Nunca
+        deliveries: Últimas entregas de webhook
+        no_deliveries: Todavía no hay entregas.
+        event: Evento
+        action: Acción
+        received_at: Recibida
+        processed_at: Procesada
+        error: Error

data/config/routes.rb

@@ -1,5 +1,10 @@
 Shiplog::Engine.routes.draw do
   get Shiplog.config.roadmap_path, to: "roadmaps#show", as: :roadmap
+  # The feed and the permalinks come before the plain changelog route, whose optional (.:format) would
+  # otherwise take /changelog.atom. A slug has no dot, and the permalink takes no format.
+  get "#{Shiplog.config.changelog_path}.atom", to: "changelog_feeds#show", as: :changelog_feed, defaults: { format: "atom" }
+  get "#{Shiplog.config.changelog_path}/:slug", to: "changelog_entries#show", as: :changelog_entry,
+    format: false, constraints: { slug: /[a-z0-9-]+/ }
   get Shiplog.config.changelog_path, to: "changelogs#show", as: :changelog
   post "shiplog/github/webhook", to: "webhooks#create", as: :github_webhook
   get "shiplog/assets/:version/:name", to: "frontends#show", as: :frontend, constraints: { version: /[^\/]+/, name: /[a-z_]+\.(css|js)/ }

data/db/migrate/20261027000001_create_shiplog_pull_request_upgrades.rb

@@ -0,0 +1,30 @@
+class CreateShiplogPullRequestUpgrades < ActiveRecord::Migration[8.1]
+  def change
+    # What upgrade detection needs from the pull request, and its "checked" marker: a pull request with
+    # no tracked upgrade has no upgrade row, so only a column can say "inspected, nothing found".
+    change_table :shiplog_pull_requests do |t|
+      t.string :base_oid
+      t.string :merge_oid
+      t.boolean :lockfile_changed, null: false, default: false
+      t.datetime :upgrades_checked_at
+      # Transient failures while inspecting it; the detector gives up (marks it checked) after a few.
+      t.integer :upgrade_check_attempts, null: false, default: 0
+    end
+
+    create_table :shiplog_pull_request_upgrades do |t|
+      t.references :pull_request, null: false, foreign_key: { to_table: :shiplog_pull_requests }, index: false
+      t.string :gem_name, null: false
+      t.string :from_ref
+      t.string :to_ref
+      t.string :gem_repository
+      # Not `changes`: that name belongs to ActiveModel::Dirty and Active Record refuses it as an attribute.
+      t.jsonb :gem_changes, null: false, default: []
+      t.timestamps
+      t.index [ :pull_request_id, :gem_name ], unique: true
+    end
+
+    # The changelog and the roadmap's recently shipped list read approved entries newest release first:
+    # `status = 'approved' ... ORDER BY released_on DESC`. Equality column first, then the sort column.
+    add_index :shiplog_entries, [ :status, :released_on ]
+  end
+end

data/db/migrate/20261027000002_shiplog_0_3_0.rb

@@ -0,0 +1,105 @@
+# Everything 0.3.0 adds to the schema, one section per feature. Additive and reversible.
+class Shiplog030 < ActiveRecord::Migration[8.1]
+  # A migration must not depend on model code that changes later: this is a bare table-backed class.
+  class MigrationEntry < ActiveRecord::Base
+    self.table_name = "shiplog_entries"
+    self.inheritance_column = nil
+  end
+
+  SLUG_MAX_LENGTH = 80
+
+  def change
+    # --- Entry permalinks (/changelog/:slug) ---
+    # Set when an entry is first approved, never changed afterwards, so links never break. Nil for roadmap
+    # entries and drafts. Entries approved before 0.3.0 get theirs here (oldest first, so the oldest keeps the
+    # plain slug on duplicate titles): the public pages never write, so nothing else fills them in.
+    add_column :shiplog_entries, :slug, :string
+    add_index :shiplog_entries, :slug, unique: true, where: "slug IS NOT NULL"
+    reversible do |direction|
+      direction.up do
+        MigrationEntry.reset_column_information
+        backfill_slugs
+      end
+    end
+
+    # --- "What's new" unseen count ---
+    # `Shiplog.unseen_count` counts approved feature and change entries with `approved_at > since`:
+    # an equality column first, then the range column.
+    add_index :shiplog_entries, [ :status, :approved_at ]
+
+    # --- Product areas (detected by AI) ---
+    # `entries.area_id` is nullable; deleting an area nullifies it (merging moves the entries first).
+    # `area_set_by_admin` marks an area chosen by hand, which detection never overwrites.
+    create_table :shiplog_areas do |t|
+      t.string :name, null: false
+      t.string :slug, null: false
+      t.integer :position, null: false, default: 0
+      # The name in each of config.locales, keyed by locale string ({ "es" => "Listas de embalaje" }); empty
+      # until translated. Slugs stay English, so ?area= URLs are shared across locales.
+      t.jsonb :name_translations, null: false, default: {}
+      t.timestamps
+    end
+    add_index :shiplog_areas, :slug, unique: true
+    add_reference :shiplog_entries, :area, null: true, index: true, foreign_key: { to_table: :shiplog_areas, on_delete: :nullify }
+    add_column :shiplog_entries, :area_set_by_admin, :boolean, null: false, default: false
+    # When detection last asked the AI about the entry (placed or not): unplaced entries are not asked again
+    # until an admin asks for a re-check.
+    add_column :shiplog_entries, :area_detected_at, :datetime
+    # A small key-value store for state that belongs to no record, e.g. the result of the last area detection
+    # (shown on the admin's Areas page).
+    create_table :shiplog_settings do |t|
+      t.string :key, null: false
+      t.jsonb :value, null: false, default: {}
+      t.timestamps
+    end
+    add_index :shiplog_settings, :key, unique: true
+
+    # --- Screenshots (needs Active Storage in the host; the columns are harmless without it) ---
+    # `image_order` is the ordered list of the entry's image blob ids, `image_alts` the alt text per blob id
+    # ({ "12" => "The dark theme" }); a missing alt text falls back to the entry's title.
+    add_column :shiplog_entries, :image_order, :jsonb, null: false, default: []
+    add_column :shiplog_entries, :image_alts, :jsonb, null: false, default: {}
+
+    # --- Translations of entries (config.locales) ---
+    # One row per entry and locale, published with the English text (no second approval). `source_digest` is the
+    # digest of the English title and body it was made from: a row whose digest differs from the entry's current
+    # text is stale and never shown. `edited_by_admin` keeps an admin's edit until the English text changes.
+    create_table :shiplog_entry_translations do |t|
+      t.references :entry, null: false, index: false, foreign_key: { to_table: :shiplog_entries, on_delete: :cascade }
+      t.string :locale, null: false
+      t.string :title, null: false
+      t.text :body, null: false, default: ""
+      t.string :source_digest, null: false
+      t.boolean :edited_by_admin, null: false, default: false
+      t.timestamps
+    end
+    add_index :shiplog_entry_translations, [ :entry_id, :locale ], unique: true
+  end
+
+  # Gives every approved feature and change with a release date, and no slug, one: the title as [a-z0-9-] only
+  # (cut at 80 characters), made unique with -2, -3, ...; entry-<id> when nothing is left. The same rules as
+  # Shiplog::Entry#generate_slug at the time of 0.3.0.
+  def backfill_slugs
+    taken = MigrationEntry.where.not(slug: nil).pluck(:slug).to_set
+    MigrationEntry.where(status: "approved", kind: %w[feature change], slug: nil).where.not(released_on: nil)
+      .order(:released_on, :approved_at, :id).to_a.each do |entry|
+      slug = slug_for(entry, taken)
+      taken << slug
+      MigrationEntry.where(id: entry.id, slug: nil).update_all(slug:)
+    end
+  end
+
+  private
+
+  def slug_for(entry, taken)
+    base = entry.title.to_s.parameterize.tr("_", "-").squeeze("-").first(SLUG_MAX_LENGTH).gsub(/\A-+|-+\z/, "").presence || "entry-#{entry.id}"
+    candidate = base
+    suffix = 2
+    while taken.include?(candidate)
+      tail = "-#{suffix}"
+      candidate = "#{base.first(SLUG_MAX_LENGTH - tail.length).delete_suffix("-")}#{tail}"
+      suffix += 1
+    end
+    candidate
+  end
+end

data/lib/generators/shiplog/install/install_generator.rb

@@ -17,9 +17,12 @@ module Shiplog
         page_header: "mb-8",
         page_title: "text-3xl font-semibold tracking-tight",
         page_lede: "mt-2 text-gray-600 dark:text-gray-400",
+        switcher: "mt-6 inline-flex gap-1 rounded-full bg-gray-100 p-1 text-sm font-medium dark:bg-gray-900",
+        switcher_link: "rounded-full px-4 py-1.5 text-gray-600 transition-colors hover:text-gray-900 focus-visible:outline-2 focus-visible:outline-offset-2 focus-visible:outline-indigo-600 aria-[current=page]:bg-white aria-[current=page]:text-gray-900 aria-[current=page]:shadow-sm dark:text-gray-400 dark:hover:text-white dark:aria-[current=page]:bg-gray-700 dark:aria-[current=page]:text-white",
         columns: "grid gap-6 md:grid-cols-3",
         column: "rounded-xl border border-gray-200 bg-gray-50 p-4 dark:border-gray-800 dark:bg-gray-900/50",
         column_header: "mb-4 border-b border-gray-200 pb-3 dark:border-gray-800",
+        column_marker: "mr-2 inline-block h-2 w-2 rounded-full bg-gray-400 in-[.shiplog-column--in-progress]:bg-indigo-600 in-[.shiplog-column--coming-soon]:bg-indigo-300",
         column_title: "inline text-base font-semibold",
         column_count: "ml-2 rounded-full bg-gray-200 px-2 py-0.5 text-xs font-medium text-gray-700 dark:bg-gray-800 dark:text-gray-300",
         column_description: "mt-1 text-sm text-gray-500 dark:text-gray-400",
@@ -28,6 +31,16 @@ module Shiplog
         card: "rounded-lg border border-gray-200 bg-white p-3 shadow-sm transition hover:border-indigo-400 hover:shadow dark:border-gray-800 dark:bg-gray-900 dark:hover:border-indigo-500",
         card_title: "font-medium",
         card_body: "mt-1 text-sm text-gray-600 dark:text-gray-400",
+        card_meta: "mt-3 flex flex-wrap items-center gap-2 text-xs font-medium text-gray-500 dark:text-gray-400",
+        card_tag: "rounded-md bg-gray-100 px-2 py-0.5 text-gray-700 dark:bg-white/10 dark:text-gray-300",
+        shipped: "mt-12 grid grid-cols-[1fr_auto] items-baseline gap-x-6 gap-y-4 border-t border-gray-200 pt-8 dark:border-gray-800",
+        shipped_title: "text-lg font-semibold",
+        shipped_list: "col-span-2 grid gap-6 sm:grid-cols-2 lg:grid-cols-4",
+        shipped_item: "flex flex-col gap-1",
+        shipped_date: "text-xs tabular-nums text-gray-500 dark:text-gray-400",
+        shipped_link: "text-sm font-semibold text-gray-900 hover:text-indigo-600 dark:text-white dark:hover:text-indigo-400",
+        footnote: "mt-10 border-t border-gray-200 pt-6 text-center text-sm text-gray-500 dark:border-gray-800 dark:text-gray-400",
+        footnote_link: "font-medium text-indigo-600 hover:underline dark:text-indigo-400",
         months: "space-y-10",
         month: "border-l-2 border-gray-200 pl-6 dark:border-gray-800",
         month_title: "mb-4 text-lg font-semibold",
@@ -40,7 +53,22 @@ module Shiplog
         entry_date: "text-xs text-gray-500 dark:text-gray-400",
         pagination: "mt-8 flex justify-between",
         pagination_link: "text-sm font-medium text-indigo-600 hover:underline dark:text-indigo-400",
-        empty: "text-gray-500 dark:text-gray-400"
+        empty: "text-gray-500 dark:text-gray-400",
+        search: "my-4 flex gap-2",
+        search_input: "min-w-0 flex-1 rounded-md border border-gray-300 bg-white px-3 py-1.5 text-sm dark:border-gray-700 dark:bg-gray-900",
+        search_button: "rounded-md bg-indigo-600 px-3 py-1.5 text-sm font-medium text-white hover:bg-indigo-500",
+        search_summary: "mb-4 text-sm text-gray-500 dark:text-gray-400",
+        search_clear: "ml-2 font-medium text-indigo-600 hover:underline dark:text-indigo-400",
+        search_empty: "text-gray-500 dark:text-gray-400",
+        permalink: "mx-auto max-w-2xl rounded-lg border border-gray-200 bg-white p-6 dark:border-gray-800 dark:bg-gray-900",
+        permalink_back: "mt-6 inline-block text-sm font-medium text-indigo-600 hover:underline dark:text-indigo-400",
+        permalink_nav: "mt-8 flex flex-wrap justify-between gap-4 border-t border-gray-200 pt-4 dark:border-gray-800",
+        permalink_nav_link: "text-sm font-medium text-indigo-600 hover:underline dark:text-indigo-400",
+        areas: "my-4 flex flex-wrap gap-2",
+        area_link: "rounded-full border border-gray-300 px-3 py-0.5 text-sm hover:border-indigo-500 dark:border-gray-700 [&.shiplog-areas__link--current]:border-indigo-600 [&.shiplog-areas__link--current]:bg-indigo-600 [&.shiplog-areas__link--current]:text-white",
+        entry_area: "text-xs font-semibold uppercase tracking-wide text-gray-500 dark:text-gray-400",
+        entry_images: "mt-3 grid w-full gap-3",
+        entry_image: "h-auto max-w-full rounded-lg border border-gray-200 dark:border-gray-800"
       }.freeze
 
       def copy_initializer

data/lib/generators/shiplog/install/templates/initializer.rb.tt

@@ -2,6 +2,21 @@ Shiplog.configure do |config|
   # GitHub repositories to sync ("owner/name"). Sub-issues may cross repositories of the same owner.
   config.repositories = %w[acme/app acme/app-ios]
 
+  # A repository can also be a Hash with options:
+  #   changelog: false  keep the repository on the roadmap, but never draft changelog entries from its PRs or commits
+  #   gem: "name"       the gem's name in your Gemfile.lock. When a merged PR upgrades it, the changelog gets one
+  #                     entry for the upgrade, built from the gem's changes. Needed because names differ
+  #                     (a "trackberry-produce" gem can live in acme/produce) and a public gem of the same name
+  #                     is not your repository.
+  # config.repositories = [
+  #   "acme/app",
+  #   { name: "acme/app-ios" },
+  #   { name: "acme/pricing", changelog: false, gem: "acme-pricing" }
+  # ]
+
+  # Lockfile read in merged pull requests to detect gem upgrades (change it for a monorepo).
+  # config.lockfile_path = "Gemfile.lock"
+
   # A String, or a callable evaluated on every GitHub request (e.g. to mint a GitHub App installation token).
   config.github_token = -> { Rails.application.credentials.dig(:github, :shiplog_token) }
 
@@ -82,5 +97,71 @@ Shiplog.configure do |config|
 
   # Public paths, read when routes are drawn.
   # config.roadmap_path = "roadmap"
-  # config.changelog_path = "changelog"
+  # config.changelog_path = "changelog"   # a-z, 0-9, - and _; "docs/news" nests; outer slashes are stripped
+
+  # The site's canonical origin (scheme, host, optional port; no path). The Atom feed's ids and links, og:url
+  # and the other absolute URLs use it instead of the request's host, which varies (apex vs www, a forged
+  # X-Forwarded-Host). Behind a proxy, also set config.assume_ssl = true (or send X-Forwarded-Proto) in Rails.
+  # config.canonical_url = "https://example.com"
+
+  # Pages added to the Roadmap / Changelog switcher. label and path are Strings, or callables evaluated in the
+  # view (route helpers, I18n). Render the same switcher on your own pages with `helper Shiplog::SwitcherHelper`
+  # and `<%%= shiplog_switcher %>`.
+  # config.extra_pages = [ { label: "News", path: -> { main_app.news_path } } ]
+
+  # Names shown on roadmap cards for the repository an item lives in (Strings or callables).
+  # config.repository_labels = { "acme/app-ios" => "iPhone & iPad" }
+
+  # How many recently shipped changelog entries the roadmap lists; 0 hides the section.
+  # config.roadmap_shipped_count = 4
+
+  # Where the roadmap's "Suggest a feature" link goes (String or callable); no link while nil. Add a footnote
+  # next to it with the shiplog.roadmap.footnote translation.
+  # config.feedback_path = -> { main_app.new_feedback_path }
+
+  # The public changelog's search box and ?q= filtering. Set to false to turn search off.
+  # config.changelog_search = true
+
+  # "What's new". Shiplog doesn't know your users, so you supply the "last seen" time. This is called with the
+  # controller on every changelog index or permalink view, BEFORE the page renders (a 304 revisit included), so a
+  # navbar badge in the same response is current. It may write and runs on every visit: keep it cheap, and write
+  # only when something is new. Show `Shiplog.unseen_count(since: user.changelog_seen_at)` (at most 99, counted on
+  # approved_at; `helper Shiplog::UnseenHelper` and `shiplog_unseen_count(since)` in views) next to your Changelog
+  # link. current_user is often private, hence controller.send (or read a Current attribute).
+  # config.on_changelog_seen = lambda do |controller|
+  #   user = controller.send(:current_user)
+  #   user.update_column(:changelog_seen_at, Time.current) if user && Shiplog.unseen_count(since: user.changelog_seen_at).positive?
+  # end
+
+  # The 0.3.0 migration gives entries approved so far their permalink slug. The public pages never write (a GET
+  # may hit a read replica), so an entry approved by older code during a deploy window has no permalink until
+  # `bin/rails shiplog:backfill_slugs` runs. Permalink pages set `content_for :shiplog_og` (Open Graph tags),
+  # `content_for :shiplog_description` and `content_for :shiplog_feed` (the Atom discovery link); Shiplog's own
+  # layout renders them, so emit them in your layout's <head> when you set `config.public_layout`.
+
+  # Product areas. The rewriter's reply may name an area (an existing one, or a new name of 1-3 words); Shiplog
+  # creates it while fewer than max_areas exist, so the AI cannot sprawl. The changelog offers an area filter
+  # (?area=slug) once two areas have published entries. Manage areas in the admin ("Areas"): rename, reorder,
+  # merge, delete, and "Detect areas" to backfill entries that have none (it reuses config.rewriter).
+  # Entries you set by hand on the edit page are never changed by the AI.
+  # config.max_areas = 8
+
+  # Screenshots in entries. They need Active Storage in your app (require "active_storage/engine", and its tables);
+  # without it they stay off and Shiplog logs that once at boot. When a draft is written, the images in the GitHub
+  # issue or pull request body are attached to the entry (GitHub image hosts only, 5 MB and PNG, JPEG, GIF or
+  # WebP at most; the token needs no extra permission). You can also upload images on the entry edit page.
+  # config.images = true
+  # config.max_images_per_entry = 4
+
+  # Translations of entries. Entries are translated into each of these locales with config.rewriter when they are
+  # approved, and again when the English title or body of an approved entry changes; the translation is published
+  # at once, with no second approval. One LLM call per entry, locale and change. Admins can edit a translation on
+  # the entry page (kept until the English text changes) or retranslate it. Pages render the translation when
+  # I18n.locale is one of these and it matches the current English text, and English otherwise. Your routes
+  # decide which URLs set the locale (e.g. a /es scope). The default locale is dropped from the list.
+  # config.locales = []   # e.g. [:es]
+
+  # Callables above cannot be part of the public pages' ETag. Bump this when the output of a callable you
+  # configured changes (a new label, another path) so cached pages are refreshed.
+  # config.cache_version = nil
 end