Skip to content

update development setup in sdk-docs #3506

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.

Sign up for GitHub

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

Merged
kianenigma merged 3 commits into from
Feb 29, 2024
Merged

update development setup in sdk-docs #3506

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0078796
update development setup in sdk-docs
kianenigma Feb 28, 2024
d201eb8
Update docs/sdk/src/reference_docs/development_environment_advice.rs
kianenigma Feb 28, 2024
7251cd6
Fix based on Liam's comments
kianenigma Feb 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions docs/sdk/src/reference_docs/development_environment_advice.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,8 @@
//! // See the polkadot-sdk CI job that checks formatting for the current version used in
//! // polkadot-sdk.
//! "rust-analyzer.rustfmt.extraArgs": ["+nightly-2024-01-22"],
//! // useful when writing documentation
//! "rust-analyzer.semanticHighlighting.doc.comment.inject.enable": true,
Comment thread
kianenigma marked this conversation as resolved.
Outdated
//! }
//! ```
//!
Expand Down Expand Up @@ -111,3 +113,38 @@
//! If you have a powerful remote server available, you may consider using
//! [cargo-remote](https://github.com/sgeisler/cargo-remote) to execute cargo commands on it,
//! freeing up local resources for other tasks like `rust-analyzer`.
//!
//! When using `cargo-remote`, you can configure your editor to perform the the typical
//! "check-on-save" remotely as well. The configuration for VSCode is as follows:
//!
//! ```json
//! {
//! "rust-analyzer.cargo.buildScripts.overrideCommand": [
//! "cargo",
//! "remote",
//! "--build-env",
//! "SKIP_WASM_BUILD=1",
//! "--",
//! "build",
Comment thread
kianenigma marked this conversation as resolved.
Outdated
//! "--message-format=json",
//! "--all-targets",
//! "--all-features",
//! "--tests",
//! "--target-dir=target/rust-analyzer"
//! ],
//! "rust-analyzer.check.overrideCommand": [
//! "cargo",
//! "remote",
//! "--build-env",
//! "SKIP_WASM_BUILD=1",
//! "--",
//! "check",
//! "--workspace",
//! "--message-format=json",
//! "--all-targets",
//! "--all-features",
//! "--tests",
Comment thread
kianenigma marked this conversation as resolved.
Outdated
//! "--target-dir=target/rust-analyzer"
//! ],
//! }
//! ```
Comment thread
kianenigma marked this conversation as resolved.