docs.rs VS serenity

Working in combination with CodeWhisperer in your IDE, you can send whole code sections to Amazon Q and ask for an explanation of what the selected code does. To show how this works, we open up the file.rs file cloned from this GitHub repository. This is part of an open source project to host documentation of crates for the Rust Programming Language, which is a language we are not familiar with.

Looks like a great initiative – I wish there was a reliable TS/JS equivalent of https://docs.rs (even considering rustdoc's deficiencies[1]).

I went through this exercise recently and so far my experience with trying to produce documentation from a somewhat convoluted TS codebase[2] has been disappointing. I would claim it's a consequence of the library's public (user-facing) API substantially differing from how the actual implementation is structured.

Typedoc produces bad results for that codebase so sphinx-js, which I wanted to use, doesn't have much to work with. I ultimately documented things by hand, for now, the way the API is meant to be used by the user.

Compare:

https://ts-results-es.readthedocs.io/en/latest/reference/api...

vs

https://tsdocs.dev/docs/ts-results-es/4.1.0-alpha.1/index.ht...

Rust Search Extension adds a section on docs.rs menubar which lists the features of a crate in a nice and easy to access format.

📝 Note: At the time of writing this post, I couldn't really locate the init function docs.rs documentation. It didn't seem easily accessible through any of the current HAL implementation documentation. Nevertheless, I reached the signature of the function through the source here.

Rust Crates are a Game-Changer 🎮:The ease of releasing a crate with `cargo publish` and the convenience of rolling out new versions amazed me. The auto-generated docs on Docs.rs. is an amazing tool, especially with docstring formatting. Doc tests serve as a two-fold tool for documenting the code and ensuring it's up-to-date.

I've found I manually type out certain subsets of URLs where possible[0], maybe that's subconsciously associated with my impression that Google Search results have gotten worse and worse over the years.

[0] https://en.wiktionary.org/wiki/ and https://docs.rs/ come to mind.

docs.rs also downloads you crate automatically to generate docs and I would guess lib.rs does something similar

There are also a few key sites you'll want to keep in your back pocket at all times: - The Standard Library Documentation has complete documentation for every std library function in Rust - crates.io is a repository for all third-party packages, and docs.rs has human-readable documentation for the overwhelming majority of them - The Rust Cookbook has some code examples for common tasks you may need to perform - Make sure you are using clippy, which is available through Rustup and can be run with cargo clippy as a replacement to cargo check, it adds additional lints for your Rust code and is very helpful for teaching many of the best practices

OTOH, source-code-generated-docs normalize how code docs are, like the rust docs.rs paradigm, so it sort of forces or encourages package creators/maintainers to write docs.

https://github.com/serenity-rs/serenity/: A Discord client, has a file containing formattable endpoint strings that are then passed to a macro to build the endpoint. These endpoints are then obtained by deconstructing an enum with the relevant fields, which is used by the client upstream to make request. I really like this approach, the use of macros and enums feels quite natural.

What would be the best coding lang for this bot, I worked with discord.py in the past but I would like to use Serenity which allows you to make a discord bot with rust.

(https://github.com/serenity-rs/serenity/pull/1899).

With forced functional programming, you may be referring to serenity's builders? For example

```rust

I am one of the core team members at shuttle, and we've released the support for Serenity (a Rust library for the Discord API) a while back and now we have a tutorial ready for anyone willing to give it a go: https://www.shuttle.rs/blog/2022/09/14/serentity-discord-bot (creating a simple Discord bot, extending it to a weather forecast bot and deploying it with shuttle, for free).

We've released the support for Serenity (a Rust library for the Discord API) a while back and now we have a tutorial ready for anyone willing to give it a go!

I coded a small discord bot for fun with some friends (using serenityserenity).

For anyone who wants to get a Discord bot up and running (with Rust) - shuttle v.0.5.1 is out, with added Serenity support.

The long term way is to use Discord's interactions system, which involves application commands (slash commands, as well as context menu commands for users and messages), message components (buttons, select menus) and modals. There appears to be some examples provided by your library, including one for slash commands and one for message components, so you could have a look at them to see how to update your bot.

Use this crate : https://docs.rs/serenity/latest/serenity/ / https://github.com/serenity-rs/serenity ?

I’m looking to make a discord bot in using the great serenity framework. The only problem is I don’t have any ideas for what the bot should do. I have decent experience with rust and have used it for small webassembly applications at work. I’ve also used serenity a bit to make a Wordle leaderboard for a server. If you have a great idea and want to work on something together, or just want to learn rust, I am definitely willing to teach a bit as well. I don’t care if the idea has been done before, I want to learn as well!