docs: rebrand site and write all guide content#2
Merged
marioalvial merged 8 commits intomainfrom Apr 14, 2026
Merged
Conversation
- Replace Mintlify logos with official Trace Finance brand SVGs - Update favicon to Trace Finance geometric icon - Switch theme from mint to palm (fintech-specific) - Add gradient background decoration and Inter fonts - Set dark mode as default, breadcrumb eyebrows, tokyo-night code blocks - Add "Get started" CTA button to navbar - Redesign landing page: rename to Home, generic description, card navigation - Simplify sandbox-note snippet - Centralize URLs as Mintlify variables (sandboxUrl, productionUrl, authUrl) - Add .nvmrc for Node 22 LTS (Mintlify CLI requirement)
Fill all stub pages with real content adapted from legacy docs:
- Authentication: Auth0 JWT flow, token lifecycle
- Environments: sandbox/production URLs, rate limits, 99.8% SLA
- Versioning: X-Trace-Version header, breaking vs non-breaking changes
- Idempotency: X-Idempotency-Key header, 409 conflict behavior
- Pagination: cursor-based with meta object (previousCursor, nextCursor)
- Money: minor units with asset field, ISO 8601 dates
- Errors: code/message/details structure, HTTP status codes, retry guidance
- Filtering: LHS Brackets syntax with operators and logical combinators (new page)
- Webhooks overview: setup, HMAC-SHA256 signature verification, retry policy
- Event reference: account, payment, and beneficiary event catalog
All URLs use {{variables}} from docs.json for single-source-of-truth.
- Quickstart: 3-step flow (get token, list accounts, check response) - Open BRL account: create, wait for activation, get funding instructions - Open crypto account: create, compliance checks, get wallet address - Deposit: intent-first and money-first flows - Withdrawal: beneficiary registration, compliance review, tracking - Swap: quote, execute, forward-only warning Journey pages link to webhook events instead of duplicating descriptions.
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
- Authentication: replace Auth0 with Trace auth service, fix endpoint to /api/oauth/client/token, camelCase fields, 1h token lifetime - URLs: remove /v1/ path segment (versioning is header-based) - Pagination: add missing params (direction, sortOrder, includeTotalMatches), fix total field description - Filtering: add missing operators (ne, text), fix like behavior - Money: add decimalValue and decimals fields to amount object - Date/time: split into its own page (guides/principles/datetime) - Idempotency: simplify conflict behavior (same key = conflict, no body check) - Webhooks: fix retry policy (constant 5min, 288 attempts), fix 5s timeout, remove section from navigation until properly documented
- Add language specifiers to fenced code blocks (MD040) - Unindent code blocks inside Tabs component (MD046) - Remove orphaned webhook pages from repo (removed from nav earlier)
- Remove all /webhooks/ links from journey pages and home (pages deleted) - Add blank lines around fenced code blocks in Tabs (MD031) - Remove Webhooks card from home page
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Takes the documentation scaffold from #1 and turns it into a fully written, branded developer portal:
23 files changed across 3 commits. All URLs use
{{variables}}fromdocs.jsonfor single-source-of-truth. Journey pages link to webhook events instead of duplicating descriptions.Test plan
mint dev— verify all pages render correctly at localhost:3000mint build— strict build passes with no errorsmint broken-links— no broken internal linksmint accessibility— alt text and color contrast pass{{variable}}interpolation works