Skip to content

docs: add bdweb end-to-end verification - #265

Open
Anurag07-crypto wants to merge 1 commit into
petercorke:feat/bdwebfrom
Anurag07-crypto:docs/bdweb-e2e-verification
Open

Anurag07-crypto wants to merge 1 commit into
petercorke:feat/bdwebfrom
Anurag07-crypto:docs/bdweb-e2e-verification

Conversation

@Anurag07-crypto

Copy link
Copy Markdown

Relates to #221

Summary

Document the manually verified end-to-end workflow for the bdweb editor in src/bdweb/README.md.

This update adds:

  • Tested environment details: Windows, Python 3.11.4, Node.js 24.12.0, npm 11.6.2, and Brave 1.99.57.
  • Installation and frontend build instructions.
  • Windows PowerShell alternatives for environments without GNU Make.
  • Step-by-step browser workflow for loading diagrams, adding blocks, wiring, editing parameters, saving, reloading, and running simulations.
  • Verification results for the browser workflow and API endpoints.

The documentation is based on the end-to-end testing performed for issue #221.

Checklist

  • The issue is assigned to me, and no other open PR addresses this documentation change.
  • This PR covers a single concern.
  • Tests were added or updated, and the full suite passes (documentation-only change; no code tests modified).
  • The code works on every Python version in the pyproject.toml classifiers (not applicable; documentation-only change).
  • This change was AI-assisted (tool: ChatGPT), and I reviewed the documentation against my actual test results.

@codacy-production

Copy link
Copy Markdown

Not up to standards ⛔

NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.

This branch has not been deployed

No deployments
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.

1 participant