rustc-dev-guide
mdBook
Our great sponsors
rustc-dev-guide | mdBook | |
---|---|---|
7 | 100 | |
1,575 | 16,669 | |
2.5% | 2.8% | |
9.3 | 8.6 | |
8 days ago | 9 days ago | |
HTML | Rust | |
Apache License 2.0 | Mozilla Public License 2.0 |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
rustc-dev-guide
-
The rust project has a burnout problem
yes, it's possible! that list doesn't exist today but i would love to create it. i wrote a draft a few years ago before shifting to other work; someone recently expressed interest in reviving that project: https://github.com/rust-lang/rustc-dev-guide/pull/1463
<3 i'm glad you enjoyed it
-
How Rust transforms into Machine Code.
It's possible - you could open an issue on the rustc-dev-guide repo if you'd like. https://github.com/rust-lang/rustc-dev-guide/
-
Accessible Documentation?
I'm very confident that this would be well received! I'm not sure where the source code for rustdoc lives, but I know that the internals getting started guide is here: https://github.com/rust-lang/rustc-dev-guide/blob/master/src/rustdoc.md. That would be a good place to start if you're looking into how the HTML is generated.
-
Yet another command line argument parser: bpaf 0.5.5
Do you have links to any good info about how much rustc reuses from previous runs? This is the first time i hear about reuse at the function level. I guess the rustc-dev-guide would be a good place for me to start?
-
Discussion Thread
Inspired by the rust compiler, you could represent the entire state of the application as a graph of operations with inputs and outputs. You can hash all the inputs and use that to memoize the operations, so that you don't have to repeat them, you can cache them in memory or on disk, and it helps you track which parts of the app state actually change between user operations and you can then be sure you put all the changes in the undo/redo stack, and so that you don't have to store duplicate copies of things that don't change. (How's that for a run-on sentence?) You could run a general binary diff algorithm between subsequent versions of the same operation with different inputs to try to reduce the memory used by storing the different versions, and have specialized diff algorithms for specific types of data. (How do you identify related operations? How much CPU does this use?) You can have a background task that compresses older versions with LZ4 or zstd. You can have a background task that saves older versions on-disk when there's memory pressure.
-
What’s everyone working on this week (11/2022)?
I contributed a couple small bugfixes for issues I ran into along the way as well. 1, 2
-
Best practices for writing code comments
It's rustdoc: https://github.com/rust-lang/rustc-dev-guide/blob/master/src...
> Rustdoc actually uses the rustc internals directly. It lives in-tree with the compiler and standard library. This chapter is about how it works. For information about Rustdoc's features and how to use them, see the Rustdoc book. For more details about how rustdoc works, see the "Rustdoc internals" chapter.
mdBook
- Doks – Build a Docs Site
-
Ask HN: How do you organize software documentation at work?
I'm responsible for a number of Java products. I try to provide high-quality Javadoc for all public library interfaces, library user's guides where appropriate, and development guides for applications. The latter two take the form of MDBook documents (https://rust-lang.github.io/mdBook/), with the document source living in the GitHub repo so that it's tied to the particular software release in a natural way.
-
Outline: Self hostable, realtime, Markdown compatible knowledge base
My org has used mdBook: https://rust-lang.github.io/mdBook/ (That link is itself a rendered mdBook, so that'll give you an idea of the feature set.)
(While it's definitely a Rust "thing", if you just have a set of .md files, all you need is a "SUMMARY.md" (which contains the ToC) and a small config file; i.e., you don't have to have any Rust code to use it, and it works fine without. We document a large, mostly non-Rust codebase with it.)
-
Ask HN: Best tools for self-authoring books in 2023?
If you want the lowest friction, open source, easily extensible Markdown to Web, Kindle, PDF, etc. tool, highly recommend mdBook: https://github.com/rust-lang/mdBook it’s written in Rust, but you don’t have to know any Rust to use it. And then wing is all CSS; for which there are many good (free) themes.
- Early performance results from the prototype CHERI ARM Morello microarchitecture
- FLaNK Stack for 4th of July
- MdBook – A command line tool to create books with Markdown
- MdBook Create book from Markdown files. Like Gitbook but implemented in Rust
-
MdBook – Create book from Markdown files. Like Gitbook but implemented in Rust
Interesting enough there seems to be an open PR for that: https://github.com/rust-lang/mdBook/pull/1918
What are some alternatives?
lang-team - Home of the Rust lang team
gitbook - The open source frontend for GitBook doc sites
bpaf - Command line parser with applicative interface
MkDocs - Project documentation with Markdown.
sensible-env-logger - A pretty, sensible, easy-to-use logger for Rust.
Wiki.js - Wiki.js | A modern and powerful wiki app built on Node.js
triagebot - Automation/tooling for Rust spaces
bookdown - Authoring Books and Technical Documents with R Markdown
isahc - The practical HTTP client that is fun to use.
obsidian-releases - Community plugins list, theme list, and releases of Obsidian.
MuOxi - MuOxi, a modern mud game engine written in Rust.
Docusaurus - Easy to maintain open source documentation websites.