Skip to content
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

Merged
merged 7 commits into from Mar 31, 2023

Conversation

rustprooflabs
Copy link
Contributor

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.

image

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

@rustprooflabs
Copy link
Contributor Author

I like the way the PL/Rust Installation sections reads now.

image

@rustprooflabs
Copy link
Contributor Author

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.

@rustprooflabs rustprooflabs changed the title Docs: Intro and Cross compile install Docs: Intro, Cross compile install, and Configuration cleanup Mar 26, 2023

The PL/Rust-specific configuration options are in the following table.
#### `plrust.compile_lints` (string)
Copy link
Contributor

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?

Copy link
Contributor Author

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?

Copy link
Contributor

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.

Copy link
Contributor Author

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.

@rustprooflabs
Copy link
Contributor Author

After adding the warning about not changing the lints, the Under the Hood section felt more appropriate for the larger Lints section. The env vars section is another thing most users shouldn't need to change.

Before

image

After

image

@eeeebbbbrrrr eeeebbbbrrrr merged commit a2e4695 into tcdi:main Mar 31, 2023
8 checks passed
@rustprooflabs rustprooflabs deleted the docs-consolidate-and-clean branch March 31, 2023 15:58
@eeeebbbbrrrr eeeebbbbrrrr mentioned this pull request Apr 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants