Generate config documentation for use on the website #3

New issue

Closed

opened 2023-11-30 05:55:52 +00:00 by girlbossceo · 4 comments

girlbossceo commented

2023-11-30 05:55:52 +00:00

(Migrated from github.com)

There are a ton that are not documented, I also think there's a workers config option maybe from one of the HTTP libraries?

Don't think it's that useful though if all the request stuff is on the main tokio runtime either way.

There are a ton that are not documented, I also think there's a `workers` config option maybe from one of the HTTP libraries? Don't think it's that useful though if all the request stuff is on the main tokio runtime either way.

❤️ 1

CobaltCause commented

2023-12-22 03:57:19 +00:00

(Migrated from github.com)

One way to do this is to generate and make available a JSON Schema document that describes the configuration file via schemars. This way, the documentation is generated from the code, which helps make sure the documentation doesn't become stale.

One way to do this is to generate and make available a JSON Schema document that describes the configuration file via [`schemars`](https://docs.rs/schemars). This way, the documentation is generated from the code, which helps make sure the documentation doesn't become stale.

girlbossceo commented

2024-03-31 04:51:18 +00:00

(Migrated from github.com)

I believe this is completed at this point. A better way to do it like mentioned above is still an option for the future, but currently the conduwuit-example.toml file has about 95% of the available config options and is kept up to date on new additions.

I believe this is completed at this point. A better way to do it like mentioned above is still an option for the future, but currently the `conduwuit-example.toml` file has about 95% of the available config options and is kept up to date on new additions.

girlbossceo commented

2024-04-27 01:25:11 +00:00

(Migrated from github.com)

Bringing this back as I'd like to get our config options documented on the website through some form of config generation / schema (see above using schemars), but I do not want to maintain two sets of documentations.

Bringing this back as I'd like to get our config options documented on the website through some form of config generation / schema (see above using `schemars`), but I do *not* want to maintain two sets of documentations.

girlbossceo commented

2024-11-16 06:49:38 +00:00

(Migrated from github.com)

We now generate our example config through a build-time proc-macro, parsing the comments in src/core/config/mod.rs, and automatically writes to conduwuit-example.toml. Further technical details about how it works may be documented on the website soon.

We now generate our example config through a build-time proc-macro, parsing the comments in `src/core/config/mod.rs`, and automatically writes to `conduwuit-example.toml`. Further technical details about how it works may be documented on the website soon.