Skip to content

update docs#34

Open
godronus wants to merge 1 commit into
masterfrom
fix/plugin-test-results
Open

update docs#34
godronus wants to merge 1 commit into
masterfrom
fix/plugin-test-results

Conversation

@godronus
Copy link
Copy Markdown
Collaborator

No description provided.

Copilot AI review requested due to automatic review settings May 23, 2026 15:02
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the docs generation pipeline and refreshes generated documentation for the AssemblyScript proxy-wasm SDK, focusing on making generated markdown more reliably “raw markdown only” and improving documentation clarity around AssemblyScript-specific pitfalls.

Changes:

  • Adjust generate-docs.sh markdown “salvage” logic to be fence-aware and require a level-1 # heading before accepting output.
  • Update docs/SDK_API.md with additional AssemblyScript constraint guidance (nested default params, empty-string fallbacks).
  • Fix markdown table formatting in docs/quickstart.md.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

File Description
fastedge-plugin-source/generate-docs.sh Improves validation/salvage of model output (fence-aware heading detection) and updates generation workflow comments.
docs/SDK_API.md Adds guidance on AssemblyScript edge cases (nested default params + empty-string fallback behavior).
docs/quickstart.md Normalizes markdown table formatting in the quickstart guide.

Comment thread fastedge-plugin-source/generate-docs.sh
Comment thread fastedge-plugin-source/generate-docs.sh
@godronus godronus requested a review from qrdl May 23, 2026 15:07
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