{"id":49560547,"url":"https://github.com/smallest-inc/smallest-ai-documentation","last_synced_at":"2026-05-03T08:04:26.747Z","repository":{"id":346333682,"uuid":"1134559696","full_name":"smallest-inc/smallest-ai-documentation","owner":"smallest-inc","description":"The Fern configuration that generates SDKs and Docs for the Smallest-Ai API","archived":false,"fork":false,"pushed_at":"2026-04-27T15:04:56.000Z","size":57099,"stargazers_count":0,"open_issues_count":3,"forks_count":1,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-04-27T15:22:17.784Z","etag":null,"topics":["built-with-fern","docs","generated-from-openapi","sdks","smallest-ai"],"latest_commit_sha":null,"homepage":null,"language":"MDX","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/smallest-inc.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-01-14T22:09:15.000Z","updated_at":"2026-04-27T15:05:09.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/smallest-inc/smallest-ai-documentation","commit_stats":null,"previous_names":["fern-demo/smallest-ai-fern-config","smallest-inc/smallest-ai-documentation"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/smallest-inc/smallest-ai-documentation","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smallest-inc%2Fsmallest-ai-documentation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smallest-inc%2Fsmallest-ai-documentation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smallest-inc%2Fsmallest-ai-documentation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smallest-inc%2Fsmallest-ai-documentation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/smallest-inc","download_url":"https://codeload.github.com/smallest-inc/smallest-ai-documentation/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smallest-inc%2Fsmallest-ai-documentation/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32562118,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-03T06:36:36.687Z","status":"ssl_error","status_checked_at":"2026-05-03T06:36:09.306Z","response_time":103,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["built-with-fern","docs","generated-from-openapi","sdks","smallest-ai"],"created_at":"2026-05-03T08:04:25.852Z","updated_at":"2026-05-03T08:04:26.740Z","avatar_url":"https://github.com/smallest-inc.png","language":"MDX","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cbr/\u003e\n\u003cdiv align=\"center\"\u003e\n\n  \u003ca href=\"https://smallest.ai\"\u003e\n    \u003cimg src=\"fern/docs/assets/logo_dark.png\" alt=\"Smallest AI\" height=\"50\"\u003e\n  \u003c/a\u003e\n\n  \u003ch1\u003eSmallest AI Documentation\u003c/h1\u003e\n\n  \u003cp\u003eSource for \u003ca href=\"https://docs.smallest.ai\"\u003e\u003cstrong\u003edocs.smallest.ai\u003c/strong\u003e\u003c/a\u003e — the unified documentation site for Smallest AI's Voice Agents (Atoms) and Models (Waves) products.\u003c/p\u003e\n\n  \u003ca href=\"https://docs.smallest.ai\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/Docs-docs.smallest.ai-2A9D8F?style=for-the-badge\u0026logo=readthedocs\u0026logoColor=white\" alt=\"Documentation\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/smallest-inc/smallest-python\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/Python%20SDK-smallest--python-blue?style=for-the-badge\u0026logo=python\u0026logoColor=white\" alt=\"Python SDK\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/smallest-inc/smallest-js\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/JS%20SDK-smallest--js-yellow?style=for-the-badge\u0026logo=javascript\u0026logoColor=white\" alt=\"JavaScript SDK\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://discord.gg/ywShEyXHBW\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/Discord-Join%20Community-5865F2?style=for-the-badge\u0026logo=discord\u0026logoColor=white\" alt=\"Discord\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://twitter.com/smallest_AI\"\u003e\n    \u003cimg src=\"https://img.shields.io/twitter/url/https/twitter.com/smallest_AI.svg?style=social\u0026label=Follow%20smallest_AI\" alt=\"Twitter\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://www.linkedin.com/company/smallest\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/LinkedIn-Connect-blue\" alt=\"LinkedIn\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://www.youtube.com/@smallest_ai\"\u003e\n    \u003cimg src=\"https://img.shields.io/static/v1?message=smallest_ai\u0026logo=youtube\u0026label=\u0026color=FF0000\u0026logoColor=white\u0026labelColor=\u0026style=for-the-badge\" height=20 alt=\"YouTube\"\u003e\n  \u003c/a\u003e\n\n\u003c/div\u003e\n\n---\n\n## About\n\nThis repository contains the source files for the Smallest AI documentation site at [docs.smallest.ai](https://docs.smallest.ai). The docs are built with [Fern](https://buildwithfern.com) and cover two products:\n\n| Product | Display Name | Description | Docs URL |\n|---|---|---|---|\n| **Atoms** | Voice Agents | End-to-end voice AI agents for telephony, web, and mobile | [docs.smallest.ai/atoms](https://docs.smallest.ai/atoms) |\n| **Waves** | Models | Text-to-Speech (Lightning) and Speech-to-Text (Pulse) APIs | [docs.smallest.ai/waves](https://docs.smallest.ai/waves) |\n\n## Repository Structure\n\n```\n.\n├── fern/\n│   ├── docs.yml                          # Main docs config (products, theme, layout)\n│   ├── fern.config.json                  # Fern org + version\n│   ├── docs/\n│   │   ├── assets/                       # Logos, favicon, CSS, images, videos\n│   │   └── changelog/                    # Changelog entries\n│   ├── apis/\n│   │   ├── atoms/openapi/                # Atoms (Voice Agents) OpenAPI spec\n│   │   ├── waves/                        # Waves OpenAPI + AsyncAPI specs (SDK generation)\n│   │   ├── waves-v4/overrides/           # Waves v4 API reference overrides (docs rendering)\n│   │   └── unified/                      # Unified SDK generator config\n│   ├── products/\n│   │   ├── atoms.yml                     # Voice Agents navigation config\n│   │   ├── atoms/pages/                  # Voice Agents documentation pages (MDX)\n│   │   ├── waves/versions/               # Models version configs (v4.0.0, v3.0.1, v2.2.0)\n│   │   └── waves/pages/                  # Models documentation pages (MDX)\n│   └── snippets/                         # Shared MDX snippets\n├── .github/workflows/\n│   ├── publish-docs.yml                  # Auto-publish on push to main\n│   ├── preview-docs.yml                  # PR preview URLs\n│   ├── python-sdk.yml                    # Python SDK generation\n│   ├── ts-sdk.yml                        # TypeScript SDK generation\n│   ├── go-sdk.yml                        # Go SDK generation\n│   └── test-quickstarts.yml              # Quickstart code sample tests\n└── README.md\n```\n\n## Which Files to Edit\n\n### Models (Waves)\n\n| What you're changing | Where to edit |\n|---|---|\n| Waves docs content (pages, guides) | `fern/products/waves/pages/v4.0.0/*.mdx` |\n| Waves sidebar navigation | `fern/products/waves/versions/v4.0.0.yml` |\n| Waves API spec (REST/HTTP endpoints) | `fern/apis/waves/openapi/*.yaml` |\n| Waves API spec (WebSocket endpoints) | `fern/apis/waves/asyncapi/*.yaml` |\n| Waves API ref page rendering (what shows on docs site) | `fern/apis/waves-v4/overrides/*.yml` |\n| Waves images | `fern/products/waves/pages/v4.0.0/images/` |\n\n### Voice Agents (Atoms)\n\n| What you're changing | Where to edit |\n|---|---|\n| Atoms docs content | `fern/products/atoms/pages/**/*.mdx` |\n| Atoms sidebar navigation | `fern/products/atoms.yml` |\n| Atoms API spec | `fern/apis/atoms/openapi/openapi.yaml` |\n| Atoms images | `fern/products/atoms/pages/images/` |\n\n### Global\n\n| What you're changing | Where to edit |\n|---|---|\n| Product toggle, global config | `fern/docs.yml` |\n| CSS / styling | `fern/docs/assets/styles/global-styling.css` |\n| Logos, favicon | `fern/docs/assets/` |\n| Shared MDX snippets | `fern/snippets/` |\n\n\u003e **Important**: The `fern/apis/waves-v4/overrides/` directory controls what renders on the docs API reference pages. The `fern/apis/waves/openapi/` and `fern/apis/waves/asyncapi/` directories are used for SDK generation. Both need to stay in sync when API parameters change.\n\n## Setup\n\n### Prerequisites\n\n- **Node.js** 18+\n- **npm** or **yarn**\n- A Fern account and `FERN_TOKEN` (for publishing)\n\n### Install Fern CLI\n\n```bash\nnpm install -g fern-api\n```\n\n### Local Development\n\nPreview the docs locally with hot-reload:\n\n```bash\nfern docs dev\n```\n\nThis starts a local server at `http://localhost:3000` with live reloading as you edit MDX and config files.\n\n### Preview a Build\n\nGenerate a preview URL (useful for PR reviews):\n\n```bash\nfern generate --docs --preview\n```\n\n### Publish to Production\n\nPublishing happens automatically when changes are merged to `main` via the `publish-docs.yml` GitHub Action. To publish manually:\n\n```bash\nFERN_TOKEN=\u003cyour-token\u003e fern generate --docs\n```\n\n### Upgrade Fern Version\n\n```bash\nfern upgrade\n```\n\nThen update the version in `fern/fern.config.json` if needed.\n\n## Contributing\n\nWe welcome contributions from the community! Here's how to get started:\n\n### 1. Fork \u0026 Clone\n\n```bash\ngit clone https://github.com/smallest-inc/smallest-ai-documentation.git\ncd smallest-ai-documentation\nnpm install -g fern-api\n```\n\n### 2. Create a Branch\n\n```bash\ngit checkout -b docs/your-change-description\n```\n\n### 3. Make Your Changes\n\n- **Content changes**: Edit MDX files in the relevant `pages/` directory (see [Which Files to Edit](#which-files-to-edit))\n- **Navigation changes**: Edit the YAML config (`atoms.yml` or `waves/versions/v4.0.0.yml`)\n- **API spec changes**: Edit OpenAPI/AsyncAPI files in `fern/apis/`\n- **Style changes**: Edit `fern/docs.yml` or `fern/docs/assets/styles/global-styling.css`\n\n### 4. Preview Locally\n\n```bash\nfern docs dev\n```\n\nVerify your changes look correct at `http://localhost:3000`.\n\n### 5. Submit a Pull Request\n\nPush your branch and open a PR against `main`. A preview URL will be automatically generated and posted as a PR comment.\n\n### Guidelines\n\n- All content pages use **MDX** format (Markdown + JSX components)\n- Follow existing naming conventions for file and folder names\n- Keep images in the `images/` directory next to the pages that use them\n- Use [Fern's component library](https://buildwithfern.com/learn/docs/content/components/overview) for callouts, cards, tabs, etc.\n- Test that internal links work by previewing locally before submitting\n\n## Related Repositories\n\n| Repository | Description |\n|---|---|\n| [smallest-python](https://github.com/smallest-inc/smallest-python) | Official Python SDK |\n| [smallest-js](https://github.com/smallest-inc/smallest-js) | Official JavaScript/TypeScript SDK |\n| [cookbook](https://github.com/smallest-inc/cookbook) | Examples and guides for using Smallest AI |\n\n## Support\n\n- **Documentation**: [docs.smallest.ai](https://docs.smallest.ai)\n- **Discord**: [Join our community](https://discord.gg/ywShEyXHBW)\n- **Email**: [support@smallest.ai](mailto:support@smallest.ai)\n- **Issues**: [Open an issue](https://github.com/smallest-inc/smallest-ai-documentation/issues)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsmallest-inc%2Fsmallest-ai-documentation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsmallest-inc%2Fsmallest-ai-documentation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsmallest-inc%2Fsmallest-ai-documentation/lists"}