Skip to content

docs: add complete sandbox onboarding - #58

Merged
mqqz merged 1 commit into
mainfrom
docs/sandbox-onboarding
Oct 26, 2026
Merged

mqqz merged 1 commit into
mainfrom
docs/sandbox-onboarding

Conversation

@mqqz

@mqqz mqqz commented Oct 26, 2026

Copy link
Copy Markdown
Owner

Developers had to assemble separate snippets to get from invoice creation to a reporting result. Add one complete sandbox walkthrough with downloadable Python, C#, and TypeScript projects using the published 0.5.0 packages.

Each program creates the same simplified invoice, signs it, validates the exact signed XML, optionally reports it, and saves the response before checking acceptance. The guide explains sandbox credentials, saved artifacts, failure handling, and the changes required for production. A ZATCA journey diagram covers onboarding, reporting, clearance, and response outcomes.

Link the walkthrough from the README and documentation homepage. Preserve existing README formatting and emojis. Check downloadable archives against their source in docs CI.

Validation:

  • All three projects installed and ran with published packages; Python uses CPython 3.13, C# uses .NET 8, and TypeScript uses Node.
  • Mock reporting checks passed for acceptance, warnings, rejection, unknown and contradictory outcomes, HTTP errors, and malformed responses. Invalid input blocked submission in all three languages; TypeScript transport failure was also checked.
  • Strict MkDocs build, archive consistency, and diff checks passed. Browser checks verified the rendered diagram and downloadable links.
  • Live ZATCA reporting was not tested: issued sandbox credentials were unavailable.

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 26, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-26T11:18:04.001890Z 0def985 PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@codecov

codecov Bot commented Oct 26, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@mqqz
mqqz merged commit e25a86c into main Oct 26, 2026
10 checks passed
@mqqz
mqqz deleted the docs/sandbox-onboarding branch October 27, 2026 12:01
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