Repository navigation
[simulate-docs] ✨ add Simulate page set alongside Validate - #12
Merged
Merged
Conversation
msanyam
added this pull request to stack #13
October 6, 2026 03:50
Contributor
🔍 Linter ReportClick to expand full reportThis comment was automatically generated by the linter bot. |
msanyam
force-pushed
the
sanyamm/feat/simulate-docs
branch
from
October 6, 2026 03:54
a1da257 to
50b4c8e
Compare
Contributor
🔍 Linter ReportClick to expand full reportThis 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
force-pushed
the
sanyamm/feat/simulate-docs
branch
from
October 6, 2026 03:54
50b4c8e to
d49ca8f
Compare
Contributor
🔍 Linter ReportClick to expand full reportThis comment was automatically generated by the linter bot. |
sabarish111
approved these changes
Oct 6, 2026
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
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.
Targets
main(#10 and #11 are merged). Commits:839b407,d49ca8f.Summary
Adds a
/simulate/page set next to/validate/, using the same page names:simulate/index.mdsimulate/core-concepts/— workspaces, simulations and runs, the four decisions, templates, audiences, asset types and sources, lifecycle (launched/draft_incomplete,summary_status), resultssimulate/using-mcp/— connection (same text as Validate's), the 8-tool table, the behavioral contract, UI panels, prompts, and the reference notesimulate/api/mcp/— Redocly →static/simulate-openapi.jsonSimulate 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.Sources
simulate-openapi.jsonis filtered from the generateddocs/api-spec/openapi.jsonin abi-simulate-mcp at662c9f8. It keeps the 8 tools integrators call, plus only the component schemas those tools reference. The internal panel toolsget_simulation_statusandupload_asset_bytesare excluded, the same wayvalidate-openapi.jsonexcludesupload_validation_asset_bytes. The tool descriptions are copied unchanged from the server.server.pydocstrings, thenew-simulationskill, andprompts.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.stage.ymlon this branch.Reviewer notes
create_simulationdescription 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.