Getting started
Welcome to the Acme Toolkit documentation. This guide walks you through installing the toolkit, configuring it for your project, and calling its core functions. Every section is reachable from the sidebar on the left.
The layout is fully fluid. On a narrow phone screen the sidebar and content stack into a single column; on a wide desktop they sit side by side. At no width does the page scroll sideways, even when a paragraph contains a verylongunbrokenstringthatwouldotherwiseforcehorizontaloverflow.
Installation
Install the package with your preferred package manager, then import it where you need it. The snippet below wraps long lines so it never widens the content pane.
npm install @acme/toolkit
import { createClient } from "@acme/toolkit";
const client = createClient({ endpoint: "https://example.test/api/v1/resources" });Configuration
Options are passed as a plain object. The table below stays within the content pane at every width and scrolls inside its own wrapper on very narrow screens rather than pushing the page.
| Option | Type | Default | Description |
|---|---|---|---|
| endpoint | string | — | Base URL the client talks to. |
| timeout | number | 30000 | Request timeout in milliseconds. |
| retries | number | 2 | How many times to retry a failed request. |
API reference
The toolkit exposes a small surface of functions for creating a client, sending requests, and handling responses. Each function is documented with its parameters and return type.
Troubleshooting
If something is not working, check your endpoint URL and network access first, then enable verbose logging to inspect the raw request and response. Most issues come down to configuration.