This repository was archived by the owner on May 11, 2026. It is now read-only.
feat: scaffold full MkDocs Material docs site - #1
Merged
Conversation
Launches the "Read the Docs of Grok agents" — dark-first, cyan-accented, client-side YAML validator, and full v2.12 spec reference. Structure: - 5 spec pages (grok-install, grok-agent, grok-workflow, grok-security, grok-prompts) grounded in real v2.12 template YAMLs - CLI reference for every subcommand (init, validate, scan, run, test, deploy, install, publish) - 10-minute first-agent tutorial + Vercel/Railway/Docker/Replit deploy guide - 5 deep-dive guides (swarms, tool schemas, safety profiles, deployment, X integration) - Live YAML playground (Monaco + Ajv, js-yaml, auto kind-detection) - Gallery of the 10 certified awesome-grok-agents templates - Ecosystem pages (xAI SDK, LiteLLM, Semantic Kernel) - For-xAI adoption guide — the business-development asset Infra: - .github/workflows/deploy.yml — GitHub Pages deploy on push to main - .github/workflows/link-check.yml — lychee on PRs - .github/workflows/sync-schemas.yml — nightly sync from agentmindcloud/grok-yaml-standards with versioned + latest directories - Custom dark theme (electric cyan on deep black), animated terminal hero, feature grid, playground UI - mkdocs build --strict passes with zero warnings
AgentMindCloud
pushed a commit
that referenced
this pull request
May 7, 2026
Cherry-picks the remaining unsalvaged work from claude/grok-docs-upgrade-phase-3-d2pr6 onto main: - playground.js: replace hardcoded SCHEMA_DIR with multi-version schema map (v2.12, latest, v2.14) so the live validator handles v2.13 and v2.14 YAML, not just v2.12. Adds visuals preview pane. - mkdocs.yml: nav restructure into v2.14 (latest) / v2.13 / v2.12 (pinned) sections; add redirects plugin so old /spec/* URLs 308 to /v2.12/spec/*. - Move docs/spec/* -> docs/v2.12/spec/* with content updates. - index.md / playground/index.md / first-agent.md / multi-agent-swarms.md: retarget links from /spec/ to /v2.12/spec/ and surface v2.14 visuals. - extra.css: styles for the new playground preview pane. - sync-schemas.yml: explicit v2.13 and v2.14 mirror handling, never clobber the frozen v2.12 directory. - requirements.txt: add mkdocs-redirects==1.2.1 and mike==2.1.3. Resolves the audit's #1 Critical finding (playground hardcoded to v2.12 while site advertises v2.14 as current). Build verified locally with mkdocs --strict. https://claude.ai/code/session_01SbuY5ocHw7SWTQMSuBeYXB
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Summary
Launches the full documentation site — dark-first MkDocs Material, five-page YAML spec reference (grok-install, grok-agent, grok-workflow, grok-security, grok-prompts), live client-side playground (Monaco + Ajv), CLI reference, getting-started tutorial, five deep-dive guides, gallery of certified templates, ecosystem integration pages, and the for-xAI adoption guide.
What's inside
deploy.yml(Pages on push to main),link-check.yml(lychee on PRs),sync-schemas.yml(nightly sync fromagentmindcloud/grok-yaml-standardsinto versioneddocs/assets/schemas/v<VERSION>/+latest/)mkdocs build --strictpasses with zero warningsTest plan
mkdocs build --strict— cleandocs/assets/schemas/latest/Notes
docs/templates/→docs/gallery/because MkDocs excludestemplates/subdirs from the built site.docs/assets/schemas/(adjusted from the root-relative path in the original spec, so mkdocs actually serves the files).https://claude.ai/code/session_01PHbVcaubUZn7QgZwrn4j9K