mirror of
https://github.com/outbackdingo/firezone.git
synced 2026-01-27 10:18:54 +00:00
6003ea7e26
1. The test data is taken from tests, you can override attributes by adding keyword params to `doc` macro; 2. Additionally, you can add a section title using a `@moduledoc` in a controller and a controller action title using `@doc` on a controller function. (It will be added to all instances of its usage). 3. To make parameters nice a helper was added to build it using `DocHelper`, you can find an example in UserController. Overall, the code is messy, I'll need to revisit it, but was doing it in a rush so hope it's good enough for v0. Results you can see at https://firezone.docs.apiary.io/. To generate it locally run `DOC=1 mix test test/fz_http_web/controllers/json`. Co-authored-by: Jamil Bou Kheir <jamilbk@users.noreply.github.com>
4 lines
302 B
Plaintext
4 lines
302 B
Plaintext
[codespell]
|
|
skip = ./docs/docs/reference/api/*.mdx,./erl_crash.dump,./apps/fz_http/erl_crash.dump,./cover,./vendor,./omnibus,*.json,yarn.lock,seeds.exs,./**/node_modules,./deps,./priv/static,./priv/plts,./**/priv/static,./.git,./docs/build,./_build
|
|
ignore-words-list = keypair,keypairs,iif,statics,wee
|