@thallylabs/migrate 0.2.10 → 0.2.12

package/README.md

@@ -26,6 +26,25 @@ instead of silently dropping that API tab's reference. AsyncAPI has no Thally
 renderer, so it always produces a clear warning naming the spec instead of
 disappearing.
 
+In-content links to auto-generated API operation pages are rewritten to the
+matching Thally `/api/...` route. A link under a known API section that matches
+no operation points to that section's overview page instead, and one warning
+lists the affected links (up to ten). A Mintlify default version's pages also
+get a redirect from their address without the version segment, since the
+original site serves them both ways.
+
+A repository is limited to 5,000 documentation files and, separately, 5,000
+asset files. Past that, files are kept in navigation order with the default
+version first, then pages not listed in navigation, and one warning counts and
+names (the first three of) the pages left out and suggests `--docs-dir` to
+migrate a smaller part of the repository. Scanning itself stops after 100,000
+files with its own warning. Individual assets over 25 MB, or beyond 500 MB in
+total, are not copied and are warned about one by one.
+
+Headings written with an explicit `{#custom-id}` become a preceding
+`<a id="custom-id"></a>` anchor and keep their text, so links to that id still
+work and the page still compiles as MDX.
+
 Docusaurus sidebars are parsed as bounded, data-only JSON5—never executed—and
 preserve explicit categories, autogenerated slices, document IDs/slugs,
 positions, generated indexes, admonitions, tabs, and `static/` assets where
@@ -148,6 +167,23 @@ the callback cannot be moved safely, it keeps the page and the control's child
 content as a passive fallback, with a warning identifying the control. A
 stateful local snippet component is kept as a client component instead of
 flattening away its hooks and state.
+A component a page declares itself (`export const Counter = () => ...`) that
+calls a React hook is moved into its own `'use client'` module, together with
+every page-local component, helper and constant it uses (a sibling it renders,
+a dependency that is itself stateful, a value only reached through a prop),
+in source order and under their original names. The imports that moved code
+needs move with it. What the page still renders stays reachable: a server-safe
+dependency the page also uses is kept in the page and copied, while a
+client-only one is imported from the module. A page-local name always wins
+over a same-named built-in. If any dependency cannot run in a client module
+(server-only APIs such as `process` or `await`, an undeclared name, a package
+the migration removed, a dynamic `import()`), the component is left where it
+is and a warning names it and the blocker.
+`<Snippet file="...">` accepts the documented `snippets/`-relative path as well
+as a `/snippets/...` or page-relative one. An outer code fence that contains a
+same-length nested fence is widened so the inner fence no longer closes it, and
+a bare placeholder tag in prose (`<Feature> requires a plan`) that would stop
+the page compiling is escaped as text rather than losing the page.
 The Mintlify `search-bar-entry` click trigger is mapped to Thally's search
 shortcut. Markdown mixed inside interactive JSX, computed imports, and
 namespace imports are reported for manual review; unsupported source is

package/dist/index.d.ts

@@ -159,6 +159,8 @@ interface MigrationPage {
     openapi?: string;
     body: string;
     source: string;
+    /** Set when the page's frontmatter was invalid YAML; the page is kept with a best-effort salvage. */
+    frontmatterError?: string;
 }
 interface MigrationAsset {
     /** Path below `public`, always normalized and traversal-free. */
@@ -389,6 +391,13 @@ declare function readFernConfig(fernRoot: string): {
 declare function projectFernNavigation(input: {
     config: Record<string, unknown>;
     fernRoot: string;
+    /**
+     * The whole repository checkout — the security boundary for anything a
+     * config file references (e.g. a `versions:` file living outside
+     * `fern/`). Defaults to `fernRoot` for callers with no wider repository
+     * context (e.g. unit tests), which reproduces the previous fernRoot-only
+     * confinement.
+     */
     repositoryRoot?: string;
 }): FernNavigationResult;