update docs#34
Open
godronus wants to merge 1 commit into
Open
Conversation
There was a problem hiding this comment.
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.shmarkdown “salvage” logic to be fence-aware and require a level-1#heading before accepting output. - Update
docs/SDK_API.mdwith 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. |
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.
No description provided.