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
The user-facing docs had several silent gaps next to the actual
code surface:
- `usage/supported/language_and_frameworks/index.md` (EN + KO) was
missing 30 of the 51 supported frameworks across Go (Hertz,
Iris), Java (Dropwizard, JAX-RS, Javalin, Micronaut, Quarkus,
Spark), JavaScript (AdonisJS, Astro, Elysia, Fresh, Hapi,
Next.js, Remix, SvelteKit, TanStack Router), Kotlin (http4k),
PHP (CodeIgniter, Slim, Yii), Python (Aiohttp, Bottle, Falcon,
Litestar, Pyramid, Starlette), Ruby (Grape, Roda), and Rust
(Poem). The sibling callee-coverage doc already lists every
framework — this is the primary support matrix catching up.
- `usage/output_formats/more/index.md` advertised `-f toml` from
the parent `_index.md` but the page itself only documented
JSONL, Postman, only-* filters, and Markdown tables. Add a TOML
section with an example payload and a note on `--diff-path`
pairing.
- `development/how_to_build/index.md` showed only the plain
`shards build`. Add `shards build --release` / `just build-release`
(alias `just br`) as the canonical command for benchmarking and
release comparisons — debug builds run 2–3× slower and have
caused a real "regression" alarm in the past.
- `get_started/running/index.md` Quick Reference table was missing
`--status-codes`, `--exclude-codes`, `--concurrency`,
`--cache-disable`, `--cache-clear`, and `--help-all`.
All four pages updated in both English and Korean.
Copy file name to clipboardExpand all lines: docs/content/development/how_to_build/index.md
+8Lines changed: 8 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -60,6 +60,14 @@ Build the project. The compiled binary ends up at `./bin/noir`.
60
60
shards build
61
61
```
62
62
63
+
For a production-grade build (slower compile, 2–3× faster runtime), pass `--release`. Use this when running benchmarks or comparing against a published release — debug builds are noticeably slower and can make a healthy build look like a regression.
64
+
65
+
```sh
66
+
shards build --release
67
+
# or use the just recipe (alias: `just br`)
68
+
just build-release
69
+
```
70
+
63
71
Run the test suite with Crystal's built-in test runner.
Copy file name to clipboardExpand all lines: docs/content/usage/output_formats/more/index.ko.md
+28Lines changed: 28 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -86,6 +86,34 @@ noir -b . -f markdown-table
86
86
| GET /1.html | http ||
87
87
| GET /2.html | http ||
88
88
89
+
## TOML
90
+
91
+
```bash
92
+
noir -b . -f toml
93
+
```
94
+
95
+
```toml
96
+
[[endpoints]]
97
+
url = "/users"
98
+
method = "GET"
99
+
100
+
[[endpoints.params]]
101
+
name = "page"
102
+
type = "query"
103
+
value = ""
104
+
105
+
[[endpoints]]
106
+
url = "/users"
107
+
method = "POST"
108
+
109
+
[[endpoints.params]]
110
+
name = "name"
111
+
type = "json"
112
+
value = ""
113
+
```
114
+
115
+
설정 파일과 같은 형식이라 터미널에서 훑어보기 좋고, 엔드포인트를 다른 선언적 설정과 함께 프로젝트 설정에 붙여넣기에도 적합합니다. TOML 직렬화는 전체 엔드포인트 모델을 그대로 담으며 `--include-callee` 와 `--ai-context` 플래그가 켜져 있을 때 그 필드도 포함합니다. `--diff-path` 와 함께 `-f toml` 을 쓰면 diff 결과도 같은 형식으로 출력됩니다.
Copy file name to clipboardExpand all lines: docs/content/usage/output_formats/more/index.md
+28Lines changed: 28 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -86,6 +86,34 @@ noir -b . -f markdown-table
86
86
| GET /1.html | http ||
87
87
| GET /2.html | http ||
88
88
89
+
## TOML
90
+
91
+
```bash
92
+
noir -b . -f toml
93
+
```
94
+
95
+
```toml
96
+
[[endpoints]]
97
+
url = "/users"
98
+
method = "GET"
99
+
100
+
[[endpoints.params]]
101
+
name = "page"
102
+
type = "query"
103
+
value = ""
104
+
105
+
[[endpoints]]
106
+
url = "/users"
107
+
method = "POST"
108
+
109
+
[[endpoints.params]]
110
+
name = "name"
111
+
type = "json"
112
+
value = ""
113
+
```
114
+
115
+
Configuration-style output that's easy to skim in a terminal or paste into a project config when you want to track endpoints alongside other declarative settings. The TOML serializer carries the full endpoint model — including `--include-callee` and `--ai-context` fields when those flags are enabled — and is also the format used by `--diff-path` output when combined with `-f toml`.
0 commit comments