poem icon indicating copy to clipboard operation
poem copied to clipboard

Add documentation for `oai` / improve discoverability

Open banool opened this issue 2 years ago • 4 comments

Currently when you search for oai in the docs, nothing comes up: https://docs.rs/poem-openapi/latest/poem_openapi/?search=oai. This is one of the most important macros for the Poem OpenAPI crate but it's hard to figure out how to use it. Could we add documentation for it if it doesn't exist and an alias so you can search for it by oai?

banool avatar Jul 13 '22 18:07 banool

I see we have docs at poem-openapi/src/docs/openapi.md, we could make an alias to go search there at least.

banool avatar Jul 13 '22 18:07 banool

I don't know how to do it. 😂

sunli829 avatar Jul 14 '22 04:07 sunli829

lol I can take a look at doing it, stay posted

banool avatar Jul 14 '22 16:07 banool

For my future self: https://doc.rust-lang.org/rustdoc/advanced-features.html. I'll take a look at this next week.

banool avatar Jul 14 '22 22:07 banool

This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days.

github-actions[bot] avatar Aug 14 '22 03:08 github-actions[bot]

This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days.

github-actions[bot] avatar Sep 14 '22 03:09 github-actions[bot]

This issue was closed because it has been stalled for 5 days with no activity.

github-actions[bot] avatar Sep 19 '22 04:09 github-actions[bot]