product-services.mdc

---
description: Product-specific guidance for Services (Infura) documentation, including naming, reference conventions, and partial reuse.
globs: services/**/*.md,services/**/*.mdx
alwaysApply: false
---

# Services (Infura)

## Product naming

- The documentation area is called **Services**.
- **Infura** is the named API and infrastructure product. Use "Infura" when referring to the
  service, endpoints, dashboard, or pricing.
- Positioning: Lead with Infura as the product (for example, "Infura offers...") rather than
  subordinating it to another brand in introductory copy.
- Do not use "MetaMask Services" as a standalone product name in headings or prose.

## Content organization

| Folder         | Content type                                    |
|----------------|-------------------------------------------------|
| `concepts/`    | Explanation (gas, transaction types, WebSockets, archive data, bundler) |
| `get-started/` | Onboarding, endpoints, Infura signup, pricing   |
| `how-to/`      | Task-oriented guides (rate limiting, IPFS, batch requests, JWT) |
| `tutorials/`   | End-to-end walkthroughs by network (Ethereum, Layer 2) |
| `reference/`   | Per-network JSON-RPC and REST API reference      |

## Reference conventions

### JSON-RPC methods

- Each method page follows the pattern: **Description**, **Parameters**, **Returns**, **Example**
  (with **Request** and **Response** subsections).
- **Parameters use nested bulleted lists**, not tables. This is the established convention across
  all network reference pages. Do not switch to tables.
- Top-level list items describe JSON-RPC `params` positions. Objects (such as a transaction call
  object) use sub-bullets with backtick field names.

### Gas API and IPFS

- The Gas API documents REST endpoints. Parameters are also documented with bulleted lists.
- IPFS documentation follows HTTP API conventions.

## Shared partials

Services reference pages make heavy use of shared MDX partials in `services/reference/_partials/`.
There are hundreds of partial files organized by method family (for example, `filter-methods/`,
`trace-methods/`, `bundler/`).

- **Shared partials** cover description, parameters, returns, and example content that is identical
  across networks.
- **Per-network request partials** (co-located with the method page as `_<method>-request.mdx`)
  customize endpoint URLs for each network.
- When updating a method's parameters or description, edit the shared partial in `_partials/`, not
  the individual network pages.

## Sidebar

The sidebar configuration is in [services-sidebar.js](services-sidebar.js). It uses Docusaurus
autogenerated sidebars for all categories. Deep structure comes from the filesystem and
`_category_.json` files.