New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Docs: Intro, Cross compile install, and Configuration cleanup #274
Docs: Intro, Cross compile install, and Configuration cleanup #274
Conversation
…s and adjusting links
… be easier to follow the steps and differences.
3rd commit cleans up the configuration page. The table with did not render well with how wide it was. Expanded details into section based format. |
doc/src/config-pg.md
Outdated
|
||
The PL/Rust-specific configuration options are in the following table. | ||
#### `plrust.compile_lints` (string) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should probably discourage users from tweaking this (or at least note that doing so can completely compromise the "trusted"-ness of plrustc).
I think if they tweak it it also prevents us from updating it in new versions?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍 Same with plrust.required_lints
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, required lints are, well, required.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, that makes sense. Thanks!
I moved the lints config section to the end of the page and added a warning to not adjust them.
Another docs related PR to fill out the earlier sections. The first commit moves more content from main project's README.md into the new documentation. This fills out the documentation's home page with more of the big concepts.
The second commit focused on adding cross compile installation steps and making the steps/differences more clear. The installation process was split into a dedicated "prereqs" section before the PL/Rust installation section. This makes the 3 installation paths (untrusted, trusted, trusted + cross compile) more obvious in the Install PL/Rust section.
The cross compile configuration notes are left behind in the 3rd section. That content will be moved into the main configuration section, probably in a new PR targeting that section.
The easiest way to preview the changes to the
mdbook
content is checking out the branch and serving the book locally. See docs/README.md