Skip to content

chore(docs): SDK page cleanup — sidebar order, example placement, JS/TS naming #274

@marythought

Description

@marythought

Summary

A few housekeeping items across the SDK docs section to improve consistency and developer experience.

Tasks

1. Rearrange SDK sidebar order

The sidebar topics under /sdks/ should follow a logical or alphabetical order that makes sense for someone working through the docs.

2. Move TDF examples below signature definitions

On the TDF page, the usage examples for each method (CreateTDF, LoadTDF, etc.) should appear directly below the signature section, before the parameter tables. Currently they're further down the page, separated from the signatures.

3. Consistent JS/TS tab naming

We use "JavaScript" in some tabs and "TypeScript" in others. Pick one and apply it consistently across all SDK pages.

4. Consistent code example structure

All SDK subpages need to follow one of two patterns consistently:

  • Complete code blocks — each example is self-contained and runnable as-is, OR
  • Setup section + snippets — the page starts with a clearly labeled Setup section (imports, auth, client init), and subsequent code snippets build on that setup

Currently some pages mix both styles, which makes it unclear whether a snippet is copy-pasteable on its own or requires setup from earlier on the page.

The Policy page is a good candidate for the setup + snippets pattern — it has many operations that share the same client setup, so repeating the full setup in every code block is unnecessary noise.


Spun off from #270 to keep that PR focused on the interceptor auth pattern changes.

🤖 Generated with Claude Code

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions