@ankhorage/paradox 0.0.0

package/.changeset/README.md

@@ -0,0 +1,5 @@
+# Changesets
+
+This directory stores release notes consumed by Changesets.
+
+Run `bun run changeset` to create a new changeset before publishing a package change.

package/.changeset/config.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://unpkg.com/@changesets/config@3.1.3/schema.json",
+  "changelog": "@changesets/cli/changelog",
+  "commit": false,
+  "fixed": [],
+  "linked": [],
+  "access": "public",
+  "baseBranch": "main",
+  "updateInternalDependencies": "patch",
+  "ignore": []
+}

package/.github/workflows/docs.yml

@@ -0,0 +1,45 @@
+name: CI
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+jobs:
+  validate:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup Bun
+        uses: oven-sh/setup-bun@v2
+        with:
+          bun-version: '1.3.11'
+
+      - name: Install dependencies
+        run: bun install --frozen-lockfile
+
+      - name: Run lint
+        run: bun run lint
+
+      - name: Check formatting
+        run: bun run format:check
+
+      - name: Run typecheck
+        run: bun run typecheck
+
+      - name: Run tests
+        run: bun run test
+
+      - name: Check changesets
+        if: github.event_name == 'pull_request'
+        run: bun run changeset:status
+
+      - name: Generate docs
+        run: bun run docs
+
+      - name: Check generated docs
+        run: git diff --exit-code

package/.prettierignore

@@ -0,0 +1 @@
+tests/__snapshots__/*.md

package/.prettierrc.js

@@ -0,0 +1,5 @@
+import { createRequire } from 'node:module';
+
+const require = createRequire(import.meta.url);
+
+export default require('@ankhorage/devtools/prettier');

package/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Changelog
+
+## 0.0.0
+
+### Initial Changes
+
+- Bootstrap Paradox with a TypeScript documentation pipeline: analyze, model, render, and write.
+- Add generated README and package export artifacts under `paradox/`.
+- Add repository config, CI validation, linting, formatting, typechecking, and bun tests.
+
+All notable changes to this project will be documented in this file.
+
+The format is based on Changesets and the package changelog generated during release.

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Ankhorage
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,49 @@
+# @ankhorage/paradox
+
+Deterministic documentation generator for TypeScript packages.
+
+## Package Exports
+
+### analyze
+
+Runs the source analysis pipeline for a configured package.
+
+### AnalysisComponent
+
+Describes one React component and its extracted props.
+
+### AnalysisExport
+
+Describes one exported declaration discovered in a package.
+
+### AnalysisResult
+
+Complete analysis output used to build the documentation model.
+
+### defineParadoxConfig
+
+Defines a Paradox configuration object without changing its shape.
+
+### ParadoxConfig
+
+Configuration for running Paradox against a TypeScript package.
+
+### buildModel
+
+Converts analysis output into a serializable documentation model.
+
+### DocumentationModel
+
+Serializable model consumed by renderers and writers.
+
+### render
+
+Renders the documentation model into README and artifact files.
+
+### RenderResult
+
+Rendered documentation files ready to be written to disk.
+
+### write
+
+Writes generated documentation artifacts to the configured output paths.