docs(builders): Mintlify MDX pack for the Builders API#1
Draft
docs(builders): Mintlify MDX pack for the Builders API#1
Conversation
Port the Builders API Mintlify pack from junction-front-end#417 into this docs repo (docs.junction.exchange): - builders/overview.mdx - builders/quickstart.mdx - builders/authentication.mdx - builders/commissions.mdx - builders/errors.mdx - builders/migrate-from-based.mdx - builders/endpoints/list-referrals.mdx - builders/endpoints/volume-30d.mdx - builders/endpoints/user-detail.mdx - builders/endpoints/summary.mdx - builders/openapi.json (version-pinned subset of junction.exchange/openapi.json) Navigation wiring in mint.json comes in a follow-up commit. Co-authored-by: Zdeadex <zdeadex@users.noreply.github.com>
- Add 'Builders API' top tab pointing to builders/overview. - Add a 'Builders API' navigation group with an Endpoints sub-group. - Register builders/openapi.json so Mintlify auto-renders REST request/response forms on endpoint pages that declare `openapi: "GET /builders/..."` in their frontmatter. Co-authored-by: Zdeadex <zdeadex@users.noreply.github.com>
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
2 participants
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.
Port du pack Mintlify de la Builders API depuis
junction-front-end#417vers ce repo, puisque c'est lui qui alimentedocs.junction.exchange.Contenu porté
Seule la partie Mintlify du PR 417 a été portée ici. Les changements de code applicatif (
projects/services/*,projects/website/*,.env.example,AGENTS.md) restent dans le repo front-end.Nouveaux fichiers — dossier
builders/builders/overview.mdx— page d'accueil de la sectionbuilders/quickstart.mdx— walkthrough curl / TypeScript / Pythonbuilders/authentication.mdx—x-api-key, rate limitsbuilders/commissions.mdx— tiers 1 / 2 / 3 et calculbuilders/errors.mdx— codes d'erreurs stables et retriablesbuilders/migrate-from-based.mdx— migration drop-in depuis based.onebuilders/endpoints/list-referrals.mdx—GET /referrals/{code}builders/endpoints/volume-30d.mdx—GET /referrals/volume_30d/{code}builders/endpoints/user-detail.mdx—GET /referrals/{code}/user/{address}builders/endpoints/summary.mdx—GET /referrals/{code}/summarybuilders/openapi.json— subset OpenAPI 3.1 version-pinné du spec global (tagbuilders)mint.jsonAPI ReferenceetIntegrations).Builders APIdans la navigation, avec un sous-groupeEndpoints.builders/openapi.jsonvia la clé"openapi"pour que Mintlify auto-rende les formulaires request / response sur chaque page endpoint (celles déclarantopenapi: "GET /builders/..."en frontmatter).Vérif
python3 -c "import json; json.load(open('mint.json')); json.load(open('builders/openapi.json'))"Les deux JSON sont valides. Le rendu effectif (preview Mintlify) sera visible sur le déploiement de la branche.
Commits
docs(builders): add Mintlify MDX pack for the Builders API— les 11 fichiers sousbuilders/.docs(builders): wire Builders API into mint.json navigation— onglet, groupe et enregistrement OpenAPI.