The APIs are flexible and easy-to-use, supporting authentication, user identity, and complex enterprise features like SSO and SCIM provisioning. Learn more →
Top 13 Rust Documentation Projects
-
WorkOS
The modern identity platform for B2B SaaS. The APIs are flexible and easy-to-use, supporting authentication, user identity, and complex enterprise features like SSO and SCIM provisioning.
-
vim-doge
(Do)cumentation (Ge)nerator for nearly 20 languages 📚 Generate proper code documentation with a single keypress. ⚡️🔥
-
InfluxDB
Power Real-Time Data Analytics at Scale. Get real-time insights from all types of time series data with InfluxDB. Ingest, query, and analyze billions of data points in real-time with unbounded cardinality.
-
mdbook-plantuml
mdBook preprocessor to render PlantUML diagrams to png images in the book output directory
In case you didn't know https://github.com/juhaku/utoipa is really nice to generate openapi spec and have a swagger!
I've been using Bevy recently so here are some thoughts on this:
Firstly, the overall quality is high and seeing this attention being paid to the project's organization is another good sign.
Documentation is not great great. The Bevy book runs out of content very quickly. The "Cheat Book" has additional useful information: https://bevy-cheatbook.github.io/. With these plus the examples I've been able to figure out everything I need, but it's slow going.
I'm not 100% sold on ECS. It loses a lot of type safety and there doesn't seem to be any way to ensure cleanup of entities and their components.
Project mention: Why is there no standard way of removing the mutability property from a reference? | /r/rust | 2023-06-21Is perfectly valid Rust code. And there's reborrow, too.
I’m the creator of the vim plugin called vim-doge and I like to share some awesome benchmark results with the new version that has been written in Rust.
Project mention: Gameboy Technical Reference for Homebrew Developers | news.ycombinator.com | 2023-11-23
If I can choose a project of mine, I'd say that https://github.com/anixe/doku was very fun to write - and it was handy too as before it people at my team were writing docs by hand 👀 (where one of our services literally has 100+ endpoints)
I started using plantuml more rigorously at work. I've found that collaboration on the drawings/diagrams, is simpler and easier as it can be tracked in Git. One additional thing that I've been using as well is the mdBook plugin to embed and render the images as part of a larger book. This has been helpful for large systems when there are many teams involved.
https://github.com/sytsereitsma/mdbook-plantuml
Project mention: Show HN: Hacker News API SDKs → Code Generation in Rust | news.ycombinator.com | 2023-10-17Hi Hacker News!
Patrick and Elias here. We built an SDK / Documentation generator for REST APIs. The link included shows the shiny output of our system: the docs! We generated 5 SDKs and docs from the Hacker News OpenAPI we found on GitHub. If you write code in Python, Typescript, Go, Ruby, or Rust, we’d love for you to try an SDK out!
If you want to generate SDKs for your own API try our tool here: https://github.com/Sideko-Inc/sideko
We are both software engineers, and we built this tool because we were spending too much time writing API integrations, supporting integrations, writing documentation, and manually testing APIs at our jobs. We think every engineer can benefit from spending less time on APIs.
The generator is written in Rust because we need the rich type system, macros, and general correctness emphasis to generate working code. The SDKs are typed, they simplify auth, and they handle files.
If you want to learn more, check out our complete write up here: https://sideko.substack.com/p/the-hacker-news-api-enhanced-b...
Thanks everyone,
PK and EP - [email protected]
Rust Documentation related posts
- Doks – Build a Docs Site
- TSDocs.dev: type docs for any JavaScript library
- Display glitch with Chromium based browsers (Chrome, Edge, and Brave)
- MdBook – Create book from Markdown files. Like Gitbook but implemented in Rust
- Why is there no standard way of removing the mutability property from a reference?
- Polkadot Forum - Advanced Level Discussion
- [Remmina] Protokolle für Remmina
-
A note from our sponsor - WorkOS
workos.com | 26 Apr 2024
Index
What are some of the best open-source Documentation projects in Rust? This list will help you:
Project | Stars | |
---|---|---|
1 | utoipa | 1,830 |
2 | bevy-cheatbook | 1,673 |
3 | reference | 1,133 |
4 | vim-doge | 961 |
5 | pandocs | 553 |
6 | rust-library-i18n | 531 |
7 | doctave | 521 |
8 | deno_doc | 250 |
9 | fundoc | 163 |
10 | doku | 80 |
11 | mdbook-plantuml | 75 |
12 | sideko | 45 |
13 | caniuse-rs | 4 |
Sponsored