Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add overview for implemented requests #412

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Nerixyz
Copy link
Contributor

@Nerixyz Nerixyz commented Apr 13, 2024

I'll rebase this once #359 is merged.

This adds a script to generate an overview over the implemented requests and helpers. It requires Rust nightly and Deno. On a high level, the script reads the Twitch docs and matches the endpoints to the implemented endpoints in this crate.

# generate JSON from docs
RUSTDOCFLAGS='-Zunstable-options --output-format json' cargo doc --no-deps -F _all
# process JSON and Twitch docs (updates in-place)
deno run --allow-net --allow-read --allow-write tools/collect-endpoints.ts

CI will check if the docs are up-to-date and provide a diff if they're not.

Towards #330.

@Nerixyz Nerixyz force-pushed the doc/autogen-overview branch 2 times, most recently from cf2bc1a to 398a580 Compare April 13, 2024 17:40
@Emilgardis
Copy link
Member

would it be possible to do this for eventsub too?

@Nerixyz
Copy link
Contributor Author

Nerixyz commented Apr 15, 2024

would it be possible to do this for eventsub too?

I've added an overview for eventsub, but the types are quite long.

before

firefox_2024-04-15_21-26-21

Updated it to fit.

firefox_2024-04-19_23-21-28

@Nerixyz Nerixyz force-pushed the doc/autogen-overview branch 5 times, most recently from 2684e96 to de40014 Compare April 20, 2024 11:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants