Skip to content

v0.1.5

Choose a tag to compare

@github-actions github-actions released this 07 Jun 10:25
· 0 commits to 057bbc024481f17296cf3846e868b8926dcbe93f since this release

Highlights

  • Friendly, key-by-key config errors. When docs.json does not validate, tangly check, migrate, dev, and build now print an exhaustive, readable report instead of a raw Zod dump. Each problem names the key (with a navigation.tabs[1].groups[0].pages style path), the line number, a plain-English reason, the offending value, and a suggested fix (Mintlify rename hints plus did-you-mean for misspelled enum values). Malformed JSON points a caret at the exact line and column.
  • Broader Mintlify compatibility. A group inside a tab can now carry its own openapi spec and expands into endpoint pages nested under that group ({ source, directory } object refs scope the generated slugs under directory). Many more real-world docs.json shapes parse unmodified: groups without pages, banner critical tone and color, errors.404 title/description, icons.library: "tabler", background.image light/dark pairs, object-form styling.codeblocks, bare-font-face fonts, metadata.timestamp, navbar social links and primary CTAs, api.auth.default, contextual.display, and thumbnails.appearance/fonts.
  • Extensive Mintlify backwards-compat CI. Tangly now vendors 24 real published docs.json configs from across the ecosystem (bun, ngrok, Cobo, Hyperswitch, Upstash, Portkey, and more, spanning six themes and 2KB to 180KB) and parses every one in CI, so a future change that breaks compatibility with a real Mintlify project fails the build.

Thanks to @quader864 for the detailed report in #6 that drove this round of compatibility work.

Changes

Features

  • feat(cli): friendly, key-by-key docs.json validation errors (#6, 5be6200)
  • feat(manifest): expand group-level OpenAPI specs (#6, 5f7ee98)
  • feat(website): showcase social cards and agent-markdown features (b73bffc)
  • feat(website): live GitHub stars + version/release pill in header (d08ed8a)

Fixes

  • fix(cli): surface friendly config errors from dev/build + migrate JSON (93a2bfd)
  • fix(schema): accept navbar/api/contextual/thumbnails shapes + 16 configs (#6, 19f72ea)
  • fix(manifest): scope object-ref openapi pages under directory (#6, a9880d7)
  • fix(schema): accept more Mintlify docs.json shapes (#6, 51774e4)
  • fix(website): show 5 themes with docs.json theme field, starter as scaffold (141efb8)

Docs

  • docs: sync npm/GitHub READMEs, correct theme and component counts (cfcbf66)

CI

  • ci(smoke): Windows CI leg + parity tests vs real Mintlify configs (#6, f358fb6)

Tests

  • test(schema): use Mintlify pages-nesting in #6 nested-group fixture (#6, 2a1b4bb)