Make documentation like the Rust community

This is a suggestion to DFINITY and the community.

People don’t seem to be fully satisfied with the current documentation about the Internet Computer. I know there are multiple efforts to fix this, like the wiki. I want to focus specifically on developer documentation.

I think that for developer documentation we should follow the example of the Rust community. I’ve never seen a software development ecosystem with such an amazing documentation experience. In the Rust ecosystem, there is a book for everything. When someone asks how do I get started with Rust, the answer is simple: Read The Book (The Rust Programming Language - The Rust Programming Language).

The Rust Book covers the basics of the language so well. It’s well-written, comprehensive, and uses a standard open source UI that many other Rust community books use as well. It creates a consistent learning experience that seems to be working very well for the Rust community.

They have a book for everything (well not everything):

I’ve followed their example with The Sudograph Book: https://i67uk-hiaaa-aaaae-qaaka-cai.raw.ic0.app/

If someone wants to learn everything about Sudograph, I have one place to send them to. It answers nearly all of their questions.

We don’t seem to have that with the Internet Computer, for software development. I would love to see The Internet Computer Book, and I think other projects should make books as well.

That’s my suggestion.

5 Likes

The Rust docs are great, but writing good docs is also a massive undertaking.

Me personally, I actually think the IC docs are really clear and well-organized, especially the Motoko code samples and the IC spec.

But yeah, I wonder if an “IC Book” could be community-led, hosted on the IC, and run by an SNS and thus tokenized to reward contributors…

3 Likes