Repository navigation
Suggestion: Full documentation via mdbook #654
Description
Have you considered adding some documentation outside of the readme, potentially with mdbook?
I ask because the readme page is getting quite lengthy, but could probably use some more detail in places like error code descriptions, command line arguments/config files (with examples) and use with editors.
A structure like rustc_error_codes crate might be good to start building. This would enable something like ruff --explain E123 in the future as well
Is there any interest? If so, I would be willing to get a PR together
Activity
charliermarsh commentedon Nov 8, 2022
Yeah this is extremely important! I've been putting it off, but the docs are falling way behind the scope of the project.
I want to be fairly intentional about creating proper docs (need to think on the exact structure and setup a bit more), but I think creating dedicated descriptions for error codes like you've described above (something could power
--explain) would be a great start. In other words: I don't know exactly where I want the docs to live etc., but something like therustc_error_codessetup looks like it could plug in to a variety of options? I would be happy to start with mdBook too with the caveat that I might move to a different system somewhere down the line (TBD).PR welcome!
tgross35 commentedon Nov 8, 2022
Sounds great! I'll get something going
charliermarsh commentedon Feb 7, 2023
We now have this working (in a basic way):
tgross35 commentedon Feb 8, 2023
Oh hey, that's awesome! Sorry I never got around to this, but glad it worked out