Changelog #8 - Docs Search, Inline SDK Installation Instructions, and Google Analytics Support

Docs Search

Demo of Search Functionality

We've added a lightning fast search bar to the docs that allows you to quickly search for your docs. The search bar is available on the top right of the docs and has a shortcut of Ctrl + K to quickly focus on it (on Mac it's Cmd + K).

Inline SDK Installation Instructions

We've added a new installation instructions section to the docs that allows you to quickly copy the SDK installation instructions for a language. This makes it easier for developers to get started with your SDKs by reducing the friction of finding the SDK installation instructions.

Google Analytics Support

konfig.yaml

_32

outputDirectory: /tmp/acme-sdks-out

_32

specInputPath: api.yaml

_32

specPath: api-fixed.yaml

_32

portal:

_32

title: Acme

_32

primaryColor: "#1f334e"

_32

logo:

_32

light: portal-logo-light.png

_32

dark: portal-logo-dark.png

_32

googleAnalyticsId: G-XXXXXXXXXX

_32

documentation:

_32

sidebar:

_32

sections:

_32

- label: Guides

_32

links:

_32

- id: getting-started

_32

path: docs/getting-started.md

_32

- id: client-side-direct-api-usage

_32

path: docs/client-side-direct-api-usage.md

_32

demos:

_32

- id: getting-started

_32

path: demos/getting-started.md

_32

generators:

_32

python:

_32

version: 1.0.0

_32

packageName: acme_client

_32

projectName: acme-python-sdk

_32

outputDirectory: python

_32

clientName: Acme

_32

git:

_32

userId: konfig-dev

_32

repoId: acme-sdks/tree/main/python

Sample configuration for Google Analytics

You can now add your Google Analytics ID to your docs configuration and we'll automatically add the Google Analytics script to your docs. See the full instructions for adding Google Analytics to your docs here.

Improvements and Fixes

• Lots of quality assurance improvements for our SDK generators (blog post incoming regarding our testing infrastructure)
• Fix defaultChangesetBumpType bug
• Remove dependency on existence of konfig.yaml when running konfig lint
• Handle submodules for Swift SDK
• Throw helpful error message when konfig.yaml is not configured when revalidating portal
• Fix some return models not being generated in documentation for TypeScript SDK
• Fix backward incompatibility in Python SDK when using new Pydantic models
• Allow default timeout to be configurable for async Python SDK usage
• Fix UI in scroll area for Docs
• Fix styling of search button mobile screens
• Fix conflict between records with same ID in search index
• Fix bug in generation of cURL command in API reference page
• Fix TypeScript SDK to work with file uploads in Node 18+
• Allow for configuration of bump type for automation at the generator level
• Add logging before error regarding dirty git repository in konfig publish
• Fix issue with poetry.lock causing automation to fail
• Add ability to render custom snippet at the top of Python SDK README.md
• More testing and reliability of latest Pydantic response models in Python SDK
• Show full URL of endpoint in API Reference page