@lexibase/rdx-types 1.1.0 → 1.2.0

package/dist/config.d.ts

@@ -34,8 +34,9 @@ export type RDXConfig = {
    */
   description?: string
   /**
-   * HTML document language, such as 'en' or 'pt-BR'.
-   * This does not automatically translate the interface or documentation.
+   * HTML document language and built-in interface translations, such as 'en' or 'pt-BR'.
+   * Portuguese locales use Brazilian Portuguese labels; unsupported languages use English.
+   * Document content and author-provided labels remain as written.
    * @defaultValue 'en'
    */
   lang?: string
@@ -195,9 +196,9 @@ export type RdxMetadata = {
   }
   /** Optional Open Graph link previews. No fixed URL is applied to every page. */
   openGraph?: {
-    /** Preview title override; defaults to metadata.applicationName. */
+    /** Site preview title; defaults to applicationName. Docs pages use their page title. */
     title?: string
-    /** Preview description override; defaults to the root description. */
+    /** Site preview description; docs use their page description or the root description. */
     description?: string
     /** Optional site name shown by platforms that support it. */
     siteName?: string
@@ -221,9 +222,9 @@ export type RdxMetadata = {
   twitter?: {
     /** Text-oriented summary or a large-image preview card. */
     card?: 'summary' | 'summary_large_image'
-    /** Card title override; defaults to metadata.applicationName. */
+    /** Site card title; defaults to applicationName. Docs pages use their page title. */
     title?: string
-    /** Card description override; defaults to the root description. */
+    /** Site card description; docs use their page description or the root description. */
     description?: string
     /** Account associated with the site, usually '@account'. */
     site?: string

package/dist/plugins.d.ts

@@ -7,6 +7,8 @@ export type RdxContentSource = {
   docsDir: string
   routePrefix: string
   badge?: string
+  /** Canonical route prefix to redirect this historical source to. */
+  redirectTo?: string
 }
 
 export type RdxPluginContext = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lexibase/rdx-types",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "license": "MIT",
   "description": "Shared TypeScript types for RDX documentation projects.",
   "types": "./dist/index.d.ts",