extism / docs Goto Github PK

View Code? Open in Web Editor NEW

0.0 4.0 2.0 4.26 MB

Documentation website for Extism

Home Page: https://extism.org

JavaScript 23.29% CSS 6.72% Dockerfile 0.39% Shell 0.29% MDX 68.08% Just 1.24%

docs's Introduction

Website

This website is built using Docusaurus 2, a modern static website generator.

Installation

Install just and node. Running just will list all recipes:

$ just
Available recipes:
    clean
    run *args
    spellcheck
    start      # Start the development server. Automatically installs dependencies.
    test

Local Development

$ just start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

You can check your changes using just test.

Build

$ just run build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

Using SSH:

$ USE_SSH=true just run deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> just run deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.

docs's People

Contributors

Watchers

Forkers

olliephillips gamote

docs's Issues

Go PDK encoding/json update

Rather than concatenating the string for output in this example, https://extism.org/docs/write-a-plugin/go-pdk/#example-usage, we should use the latest capabilities of TinyGo's implementation of encoding/json package. Would need to test that it actually works though :)

Documentation Update: Clarify timeout logic for Plugins + Host Functions

Add Moonbit PDK to list of supported languages

https://discord.com/channels/1011124058408112148/1246483784740900874/1259888436358418443

CLI manifest flags undocumented and not part of the --help output

Suggested minor improvement for docs and CLI help output. The manifest flags available on the CLI application are largely undocumented and not output on --help either.

For instance --allowedHosts

Perhaps I can submit a PR for the documentation if you agree there is a gap here? Possibly the CLI help output also.

Add Zig Host and Plugin quickstart

https://extism.org/docs/quickstart/host-quickstart/

https://extism.org/docs/quickstart/plugin-quickstart

Move SDK and PDK Docs closer to the code

We should remove the [“integrating into your application”](https://extism.org/docs/integrate-into-your-codebase/dotnet-host-sdk) docs and the [”write a plugin”](https://extism.org/docs/write-a-plugin/js-pdk) docs. Instead they should link to either the README of the SDK or the PDK or the hosted documentation.
- e.g., if the ecosystem supports it, we should have this documentation in the actual code itself and have the readme linked there. [Elixir is a good example.](https://hexdocs.pm/extism/readme.html)
- If the ecosystem doesn’t have a standard way to do this or it’s cumbersome, then the examples and docs should be written in the README and in the code.
- (4 hours [being conservative in case docs need to be written])

Create Quickstart guides for SDKs and PDKs

All docs should be written to start with the simplest copy-pasteable example of getting things running. The quickstart approach.
- This should be flawless and work every time.
- After that section there should be sections about variables, configs, http, etc.
- There should be a section focused on Host Functions as well.
- There should be a concise example showing how to get strings in and out of a wasm plugin.
- (4 hours)
Should show simplest way to use a Host SDK
At the end of the guide we should link to the actual repos / docs for the SDKs you are using to learn more. The goal should be to show the flexibility of choosing a host and guest language as well as get someone to that “success” point as quick as possible.
Should show the simplest way to write a plugin (or download one)
You should be able to click a tab to switch languages.
The examples will be loaded directly from Github using docusaurus plugin
Examples will be integration tested in the repos
(16 hours)

Document `EXTISM_ENABLE_WASI_OUTPUT`

EXTISM_ENABLE_WASI_OUTPUT=1 will enable any write to stdout or stderr from the plugin (using WASI) proxy to the host's stdout or stderr.

cc/ @chrisdickinson (once this is done in JS, we should put it in the docs. if we don't get it into the JS SDK, we can document it as such)

Add Instructions for removing legacy (python) Extism CLI during upgrade

As an Extism user who is upgrading from the legacy Python Extism CLI to the new Go based CLI, I would like to have instructions for how to purge the old CLI, so that I can have the smoothest upgrade experience possible

Update here (or the equivalent in the new doc structure)

https://extism.org/docs/install

We want to give people the ability to make PRs into the Extism Docs
Ideally we could put it in the main extism repo
opening up the docs repo could work too

Errors / FAQ Page

Errors / FAQ Page
- Mostly a traditional FAQ page but would contain common errors as well
  - We should look through Discord and Issue tracker for sourcing these
- easily searchable
- We’d be able to easily link to these with a header from exceptions. For example, the common WASI error message could link to: https://extism.org/faq/#err-42-wasi-functions-not-present
- (8 hours)

Update main docs / marketing site

This is the “main” marketing site too, so we should have some nice graphics/assets to dress it up with.
Positioning: the WebAssembly Framework vs. Universal Plug-in System
- Use cases:
  - Plug-in System
  - Serverless / FaaS
  - Web Applicationsd
  - Web hook replacement (run customer code, don’t send events)
- Demos of each use case would be great to showcase

Revamp: https://extism.org/docs/overview