Skip to content

[simulate-docs] ✨ add Simulate page set alongside Validate - #12

Merged
msanyam merged 2 commits into
mainfrom
sanyamm/feat/simulate-docs
Oct 6, 2026
Merged

msanyam merged 2 commits into
mainfrom
sanyamm/feat/simulate-docs

Conversation

@msanyam

@msanyam msanyam commented Oct 5, 2026 •

Copy link
Copy Markdown
Collaborator

Targets main (#10 and #11 are merged). Commits: 839b407, d49ca8f.

Summary

Adds a /simulate/ page set next to /validate/, using the same page names:

Page Path
Overview simulate/index.md
Core Concepts simulate/core-concepts/ — workspaces, simulations and runs, the four decisions, templates, audiences, asset types and sources, lifecycle (launched / draft_incomplete, summary_status), results
Using MCP simulate/using-mcp/ — connection (same text as Validate's), the 8-tool table, the behavioral contract, UI panels, prompts, and the reference note
MCP Tools Reference simulate/api/mcp/ — Redocly → static/simulate-openapi.json

Simulate is available only over MCP, so it has no REST reference, Authentication, Using Postman, Using curl, or Review Feedback page. Those can be added later.

Other changes

  • config.md: Simulate added to the top nav, a /simulate/ sidebar, and "Simulate MCP Tools" under API Reference.
  • Homepage: the overview now describes both capabilities. The Discover section has new Simulate blocks, and the existing Validate block is now headed "Validate" instead of "Get Started".

Sources

  • simulate-openapi.json is filtered from the generated docs/api-spec/openapi.json in abi-simulate-mcp at 662c9f8. It keeps the 8 tools integrators call, plus only the component schemas those tools reference. The internal panel tools get_simulation_status and upload_asset_bytes are excluded, the same way validate-openapi.json excludes upload_validation_asset_bytes. The tool descriptions are copied unchanged from the server.
  • The tool table, behavioral contract, and prompts come from server.py docstrings, the new-simulation skill, and prompts.py.

Testing

  • runLint: 15 files, 0 issues. runLint --internal-links-only: 0 errors. I confirmed this check fails when a link is broken by adding a bad link and seeing it reported.
  • Not checked: how the new top-nav entry and sidebar look on the rendered site. To check, run stage.yml on this branch.

Reviewer notes

  • The create_simulation description in the OpenAPI file comes from the server unchanged, and it says "finish in the tile". "Tile" is an internal term. Fixing it would mean changing the server docstring and regenerating the spec, not editing this file.

@msanyam
msanyam added this pull request to stack #13 October 6, 2026 03:50
@github-actions

github-actions Bot commented Oct 6, 2026

Copy link
Copy Markdown
Contributor

🔍 Linter Report

Click to expand full report
═══════════════════════════════════════════════════════════════
                     LINTER REPORT
═══════════════════════════════════════════════════════════════

Generated: 2026-10-06T03:50:37.436Z
Mode: Full Linting (all rules + dead links check)
Target Directory: /home/runner/work/abi-docs/abi-docs

───────────────────────────────────────────────────────────────

Files to process: 15


═══════════════════════════════════════════════════════════════
                        SUMMARY
═══════════════════════════════════════════════════════════════

  📁 Files processed:    15
  📄 Files with issues:  0
  ❌ Total errors:       0
  ⚠️  Total warnings:     0
  📋 Total issues:       0

Result: ✅ PASSED - All files passed linting successfully!

═══════════════════════════════════════════════════════════════

This comment was automatically generated by the linter bot.

@msanyam
msanyam force-pushed the sanyamm/feat/simulate-docs branch from a1da257 to 50b4c8e Compare October 6, 2026 03:54
@github-actions

github-actions Bot commented Oct 6, 2026

Copy link
Copy Markdown
Contributor

🔍 Linter Report

Click to expand full report
═══════════════════════════════════════════════════════════════
                     LINTER REPORT
═══════════════════════════════════════════════════════════════

Generated: 2026-10-06T03:54:36.481Z
Mode: Full Linting (all rules + dead links check)
Target Directory: /home/runner/work/abi-docs/abi-docs

───────────────────────────────────────────────────────────────

Files to process: 15


═══════════════════════════════════════════════════════════════
                        SUMMARY
═══════════════════════════════════════════════════════════════

  📁 Files processed:    15
  📄 Files with issues:  0
  ❌ Total errors:       0
  ⚠️  Total warnings:     0
  📋 Total issues:       0

Result: ✅ PASSED - All files passed linting successfully!

═══════════════════════════════════════════════════════════════

This comment was automatically generated by the linter bot.

Base automatically changed from sanyamm/feat/validate-docs-restructure to main October 6, 2026 03:54
Adds /simulate/ with Overview, Core Concepts, Using MCP, and an MCP Tools
reference, mirroring the /validate/ structure. Simulate is MCP-only, so
there is no REST reference, authentication, Postman, curl, or review
feedback page.

- simulate-openapi.json: filtered from abi-simulate-mcp's generated
  docs/api-spec/openapi.json (662c9f8) to the 8 integrator-facing tools;
  internal panel tools get_simulation_status and upload_asset_bytes are
  excluded, matching the validate-openapi.json convention.
- Tool table and behavioral contract are sourced from server.py
  docstrings, the new-simulation skill, and prompts.py.
- config.md: Simulate in the top nav, its own sidebar, and Simulate MCP
  Tools under API Reference.
- Homepage: overview covers both capabilities; Discover gains Simulate
  blocks and the Validate block is headed "Validate".
@msanyam
msanyam force-pushed the sanyamm/feat/simulate-docs branch from 50b4c8e to d49ca8f Compare October 6, 2026 03:54
@github-actions

github-actions Bot commented Oct 6, 2026

Copy link
Copy Markdown
Contributor

🔍 Linter Report

Click to expand full report
═══════════════════════════════════════════════════════════════
                     LINTER REPORT
═══════════════════════════════════════════════════════════════

Generated: 2026-10-06T03:55:22.018Z
Mode: Full Linting (all rules + dead links check)
Target Directory: /home/runner/work/abi-docs/abi-docs

───────────────────────────────────────────────────────────────

Files to process: 15


═══════════════════════════════════════════════════════════════
                        SUMMARY
═══════════════════════════════════════════════════════════════

  📁 Files processed:    15
  📄 Files with issues:  0
  ❌ Total errors:       0
  ⚠️  Total warnings:     0
  📋 Total issues:       0

Result: ✅ PASSED - All files passed linting successfully!

═══════════════════════════════════════════════════════════════

This comment was automatically generated by the linter bot.

@msanyam
msanyam merged commit 81f3260 into main Oct 6, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants