You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit d1cf878
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: README.md
+30-30Lines changed: 30 additions & 30 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,36 +23,36 @@ The full documentation is at https://offerrall.github.io/func-to-web/.
23
23
24
24
## Documentation
25
25
26
-
-[Overview](docs/overview.md): the same function as a form, an API, a contract and a modal; how it works, what it offers and how it compares.
27
-
-[Getting started](docs/getting-started.md): write your first function and run it.
28
-
-[Examples](docs/examples.md): the runnable examples and mini-apps, how to run them, and what each folder teaches.
29
-
-[`run()`](docs/run.md): the standalone application and the space index.
30
-
-[`app_of()`](docs/router.md): mounting the application in an existing FastAPI host application.
31
-
-[Types and validation](docs/types.md): constraints, dataclasses, lists, unions, optionals and defaults.
32
-
-[Prefill and hidden parameters](docs/prefill.md): open a form with initial values, from Python or from the URL.
33
-
-[Files](docs/files.md): uploads, reusable file references, and which layer applies each limit.
34
-
-[`WebFunction` and `WebFunctions`](docs/web-function.md): the name, description and slug of a function; prepared spaces.
35
-
-[Execution over HTTP](docs/http.md): `/invoke`, the request body, the envelope and the status codes.
36
-
-[Streaming](docs/streaming.md): `/invoke-stream`, SSE events and `print()` capture.
37
-
-[Outputs](docs/outputs.md): text, images, tables and downloads with `Download`.
38
-
-[`OpenForm`](docs/open-form.md): open another function's form with the return value as prefill.
39
-
-[`/doc`](docs/api-docs.md): the published contract that a client or an agent consumes.
40
-
-[`sdk.js`](docs/sdk.md): the helpers that call a space from your own frontend, and how to embed a function's page in another site.
41
-
-[Static assets](docs/static-assets.md): `/static`, the icons, the theme and how they are cached.
42
-
-[Security](docs/security.md): what FuncToWeb covers and what belongs to the host application.
43
-
-[Architecture](docs/architecture.md): the layers and what each one solves.
44
-
-[Limitations](docs/limitations.md): the known limits, in a single list.
26
+
-[Overview](https://offerrall.github.io/func-to-web/): the same function as a form, an API, a contract and a modal; how it works, what it offers and how it compares.
27
+
-[Getting started](https://offerrall.github.io/func-to-web/getting-started/): write your first function and run it.
28
+
-[Examples](https://offerrall.github.io/func-to-web/examples/): the runnable examples and mini-apps, how to run them, and what each folder teaches.
29
+
-[`run()`](https://offerrall.github.io/func-to-web/run/): the standalone application and the space index.
30
+
-[`app_of()`](https://offerrall.github.io/func-to-web/router/): mounting the application in an existing FastAPI host application.
31
+
-[Types and validation](https://offerrall.github.io/func-to-web/types/): constraints, dataclasses, lists, unions, optionals and defaults.
32
+
-[Prefill and hidden parameters](https://offerrall.github.io/func-to-web/prefill/): open a form with initial values, from Python or from the URL.
33
+
-[Files](https://offerrall.github.io/func-to-web/files/): uploads, reusable file references, and which layer applies each limit.
34
+
-[`WebFunction` and `WebFunctions`](https://offerrall.github.io/func-to-web/web-function/): the name, description and slug of a function; prepared spaces.
35
+
-[Execution over HTTP](https://offerrall.github.io/func-to-web/http/): `/invoke`, the request body, the envelope and the status codes.
36
+
-[Streaming](https://offerrall.github.io/func-to-web/streaming/): `/invoke-stream`, SSE events and `print()` capture.
37
+
-[Outputs](https://offerrall.github.io/func-to-web/outputs/): text, images, tables and downloads with `Download`.
38
+
-[`OpenForm`](https://offerrall.github.io/func-to-web/open-form/): open another function's form with the return value as prefill.
39
+
-[`/doc`](https://offerrall.github.io/func-to-web/api-docs/): the published contract that a client or an agent consumes.
40
+
-[`sdk.js`](https://offerrall.github.io/func-to-web/sdk/): the helpers that call a space from your own frontend, and how to embed a function's page in another site.
41
+
-[Static assets](https://offerrall.github.io/func-to-web/static-assets/): `/static`, the icons, the theme and how they are cached.
42
+
-[Security](https://offerrall.github.io/func-to-web/security/): what FuncToWeb covers and what belongs to the host application.
43
+
-[Architecture](https://offerrall.github.io/func-to-web/architecture/): the layers and what each one solves.
44
+
-[Limitations](https://offerrall.github.io/func-to-web/limitations/): the known limits, in a single list.
45
45
46
46
### Maintaining
47
47
48
-
-[The space index](docs/design/run.md): why the page `run()` adds at `/` navigates with `location.replace()` and carries no form logic of its own.
49
-
-[The application](docs/design/router.md): why both storage TTLs default to one hour, and why the theme is resolved in pure CSS.
50
-
-[Prefill: from the query parameter to the plan](docs/design/prefill.md): what happens between the `prefill` query parameter and the HTML that is served.
51
-
-[Files: the upload endpoint, the reference and custody](docs/design/files.md): why `/upload` does not apply `FileHint.max_size`, why a second upload of the same reference is a `409`, and where custody of a promoted file ends up.
52
-
-[`WebFunction` metadata](docs/design/web-function.md): why the description is passed through `cleandoc()`, and why only the first letter of a displayed name is uppercased.
53
-
-[Streaming and print capture](docs/design/streaming.md): how `print()` capture works, why it is experimental, and why the transport polls.
54
-
-[Outputs](docs/design/outputs.md): why table rows are read with `itertuples()`, why a matplotlib figure is closed, and why a union cannot mix a download with an ordinary branch.
55
-
-[The iframe channel: three decisions](docs/design/sdk.md): why the modal does not close itself by default, why `error` is not about validation, and why the payload of `result` is the envelope of `/invoke` again.
56
-
-[Frontend: assets, icons and color](docs/design/frontend.md): why the content type is decided rather than guessed, why every icon is a file, and why the page adds almost no color of its own.
57
-
-[Architecture: what counts as public contract](docs/design/architecture.md): why the line between the public API and the merely visible internals falls where it does.
58
-
-[What changed underneath, from 1.6 to 2.0](docs/design/history-1.6-to-2.0.md): why 2.0 breaks what it breaks: the two layers underneath were rewritten, and what that widened, lost and left as a limit.
48
+
-[The space index](https://offerrall.github.io/func-to-web/design/run/): why the page `run()` adds at `/` navigates with `location.replace()` and carries no form logic of its own.
49
+
-[The application](https://offerrall.github.io/func-to-web/design/router/): why both storage TTLs default to one hour, and why the theme is resolved in pure CSS.
50
+
-[Prefill: from the query parameter to the plan](https://offerrall.github.io/func-to-web/design/prefill/): what happens between the `prefill` query parameter and the HTML that is served.
51
+
-[Files: the upload endpoint, the reference and custody](https://offerrall.github.io/func-to-web/design/files/): why `/upload` does not apply `FileHint.max_size`, why a second upload of the same reference is a `409`, and where custody of a promoted file ends up.
52
+
-[`WebFunction` metadata](https://offerrall.github.io/func-to-web/design/web-function/): why the description is passed through `cleandoc()`, and why only the first letter of a displayed name is uppercased.
53
+
-[Streaming and print capture](https://offerrall.github.io/func-to-web/design/streaming/): how `print()` capture works, why it is experimental, and why the transport polls.
54
+
-[Outputs](https://offerrall.github.io/func-to-web/design/outputs/): why table rows are read with `itertuples()`, why a matplotlib figure is closed, and why a union cannot mix a download with an ordinary branch.
55
+
-[The iframe channel: three decisions](https://offerrall.github.io/func-to-web/design/sdk/): why the modal does not close itself by default, why `error` is not about validation, and why the payload of `result` is the envelope of `/invoke` again.
56
+
-[Frontend: assets, icons and color](https://offerrall.github.io/func-to-web/design/frontend/): why the content type is decided rather than guessed, why every icon is a file, and why the page adds almost no color of its own.
57
+
-[Architecture: what counts as public contract](https://offerrall.github.io/func-to-web/design/architecture/): why the line between the public API and the merely visible internals falls where it does.
58
+
-[What changed underneath, from 1.6 to 2.0](https://offerrall.github.io/func-to-web/design/history-1.6-to-2.0/): why 2.0 breaks what it breaks: the two layers underneath were rewritten, and what that widened, lost and left as a limit.
0 commit comments