-
Notifications
You must be signed in to change notification settings - Fork 7
[TOO-429] Improving docs gen provider id matching and updating engine api accesses for metadaqa #763
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
[TOO-429] Improving docs gen provider id matching and updating engine api accesses for metadaqa #763
Changes from all commits
Commits
Show all changes
17 commits
Select commit
Hold shift + click to select a range
464ac0e
[TOO-429] Improving docs gen provider id matching and updating engine…
jottakka 27896f5
fixing extra section
jottakka a6d9fd3
merge
jottakka ccb5d72
Merge branch 'main' into francisco/too-429/some-tweacks-docs-gen
jottakka 8e6325f
Regenerate clean markdown files
github-actions[bot] 8ed38c0
removing pre commit stash+format
jottakka f7c9527
Merge branch 'main' into francisco/too-429/some-tweacks-docs-gen
jottakka fa9da7a
Regenerate clean markdown files
github-actions[bot] adc0afd
fixing the links in the framework overview (#772)
nearestnabors e3d0f00
Add CLAUDE.md for Claude Code onboarding (#769)
evantahler 4d46d48
Preferred locale english only (#753)
teallarson 4654042
Regenerate clean markdown files
github-actions[bot] dcf43fe
Regenerate clean markdown files
github-actions[bot] e30eead
fix broken test
jottakka fb283f6
Regenerate clean markdown files
github-actions[bot] e7d637c
Regenerate clean markdown files
github-actions[bot] 6ccd81a
Regenerate clean markdown files
github-actions[bot] File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| # Arcade Docs | ||
|
|
||
| Arcade documentation site built with Next.js + Nextra (App Router), using pnpm as the package manager. Content is authored in MDX with custom React components. Check `package.json` for current framework versions. | ||
|
|
||
| ## Commands | ||
|
|
||
| ```bash | ||
| pnpm dev # Local dev server (port 3000) | ||
| pnpm build # Full production build (toolkit-markdown → next build → pagefind) | ||
| pnpm lint # Lint with Ultracite (Biome-based) | ||
| pnpm format # Auto-format with Ultracite | ||
| pnpm test # Run all Vitest tests | ||
| pnpm test:watch # Watch mode | ||
| pnpm vale:check # Check docs against style rules | ||
| ``` | ||
|
|
||
| Run a single test: | ||
| ```bash | ||
| pnpm vitest run tests/broken-link-check.test.ts | ||
| ``` | ||
|
|
||
| ## Architecture | ||
|
|
||
| - **`app/en/`** — English docs content (MDX pages). Nextra file-based routing with `_meta.tsx` for navigation order. i18n handled via `middleware.ts`. | ||
| - **`app/_components/`** — Shared React components (tabbed code blocks, toolkit docs, callouts, etc.). | ||
| - **`app/_lib/`** — Data-fetching utilities (toolkit catalog, slug generation, static params). | ||
| - **`app/api/`** — API routes (markdown export, toolkit-data, glossary). | ||
| - **`toolkit-docs-generator/`** — Generates MCP toolkit documentation from server metadata JSON files in `toolkit-docs-generator/data/toolkits/`. | ||
| - **`scripts/`** — Build/CI scripts (clean markdown export, Vale style fixes, redirect checking, pagefind indexing, i18n sync). | ||
| - **`tests/`** — Vitest tests (broken links, internal link validation, sitemap, smoke tests). | ||
| - **`lib/`** — Next.js utilities (glossary remark plugin, llmstxt plugin). | ||
| - **`next.config.ts`** — Contains ~138 redirect rules. | ||
|
|
||
| ## Content Authoring | ||
|
|
||
| Follow **STYLEGUIDE.md** for writing standards and **AUTHORING.md** for formatting conventions. Key points: | ||
|
|
||
| - Sentence case for headings. Active voice. Direct tone. | ||
| - Product is always "Arcade" (never abbreviated, never "Arcade AI"). | ||
| - Use "Arcade Engine" (capitalized), "MCP server" (lowercase server), "tool" (lowercase), "auth provider". | ||
| - Code snippets: 4 spaces for Python, 2 spaces for other languages. | ||
| - Run `pnpm vale:check` before submitting docs changes. | ||
|
|
||
| ## Pre-commit Hooks | ||
|
|
||
| Husky runs on commit: Vale style checks on `.md/.mdx`, `_meta.tsx` key validation, redirect checking for deleted/renamed pages, internal link updates, and Ultracite formatting. You MUST fix any issues surfaced by the pre-commit hooks. NEVER bypass hooks with `--no-verify` or similar flags. | ||
|
|
||
| ## Key Config Files | ||
|
|
||
| - `biome.jsonc` — Linter/formatter rules (Biome via Ultracite) | ||
| - `.vale.ini` — Vale style checker config (Google style base + Arcade vocabulary) | ||
| - `.nvmrc` — Required Node version | ||
| - `tsconfig.json` — TypeScript compiler configuration | ||
| - `components.json` — shadcn/ui component config | ||
| - `postcss.config.mjs` — PostCSS/Tailwind config | ||
|
|
||
| ## Code Quality | ||
|
|
||
| NEVER add suppression comments (`// @ts-ignore`, `// @ts-expect-error`, `// biome-ignore`, `eslint-disable`, `{/* prettier-ignore */}`, etc.) to bypass TypeScript or linter errors. Fix the underlying issue instead. |
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
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
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
13 changes: 0 additions & 13 deletions
13
app/en/resources/integrations/others/[toolkitId]/_meta.tsx
This file was deleted.
Oops, something went wrong.
10 changes: 0 additions & 10 deletions
10
app/en/resources/integrations/others/[toolkitId]/page-impl.tsx
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
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
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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.