Skip to content

Commit d4a6970

Browse files
committed
Remove faq landing page, improve main one
1 parent 8cc4de6 commit d4a6970

File tree

1 file changed

+12
-51
lines changed

1 file changed

+12
-51
lines changed

src/tools/rust-analyzer/editors/code/package.json

+12-51
Original file line numberDiff line numberDiff line change
@@ -3186,12 +3186,10 @@
31863186
"when": "inRustProject"
31873187
},
31883188
{
3189-
"command": "rust-analyzer.openWalkthrough",
3190-
"when": "inRustProject"
3189+
"command": "rust-analyzer.openWalkthrough"
31913190
},
31923191
{
3193-
"command": "rust-analyzer.openFAQ",
3194-
"when": "inRustProject"
3192+
"command": "rust-analyzer.openFAQ"
31953193
}
31963194
],
31973195
"editor/context": [
@@ -3228,6 +3226,15 @@
32283226
"title": "Learn about rust-analyzer",
32293227
"description": "A brief introduction to get started with rust-analyzer. Learn about key features and resources to help you get the most out of the extension.",
32303228
"steps": [
3229+
{
3230+
"id": "setup",
3231+
"title": "Useful Setup Tips",
3232+
"description": "There are a couple of things you might want to configure upfront to your tastes. We'll name a few here but be sure to check out the docs linked below!\n\n**Marking library sources as readonly**\n\nAdding the following to your settings.json will mark all Rust library sources as readonly:\n```json\n\"files.readonlyInclude\": {\n \"**/.cargo/registry/src/**/*.rs\": true,\n \"**/lib/rustlib/src/rust/library/**/*.rs\": true,\n},\n```\n\n**Check on Save**\n\nBy default, rust-analyzer will run `cargo check` on your codebase when you save a file, rendering diagnostics emitted by `cargo check` within your code. This can potentially collide with other `cargo` commands running concurrently, blocking them from running for a certain amount of time. In these cases it is recommended to disable the `rust-analyzer.checkOnSave` configuration and running the `rust-analyzer: Run flycheck` command on-demand instead.",
3233+
"media": {
3234+
"image": "./icon.png",
3235+
"altText": "rust-analyzer logo"
3236+
}
3237+
},
32313238
{
32323239
"id": "docs",
32333240
"title": "Visit the docs!",
@@ -3243,7 +3250,7 @@
32433250
{
32443251
"id": "faq",
32453252
"title": "FAQ",
3246-
"description": "Have questions about rust-analyzer? Check out the [FAQ Walkthrough](command:rust-analyzer.openFAQ)!",
3253+
"description": "What are these code hints that are being inserted into my code?\n\nThese hints are called inlay hints which rust-analyzer support and are enabled by default in VSCode. If you wish to disable them you can do so via the `editor.inlayHints.enabled` setting.",
32473254
"media": {
32483255
"image": "icon.png",
32493256
"altText": "rust-analyzer logo"
@@ -3260,52 +3267,6 @@
32603267
"completionEvents": [
32613268
"onLink:https://rust-analyzer.github.io/thisweek"
32623269
]
3263-
},
3264-
{
3265-
"id": "revisit",
3266-
"title": "Want to revisit a walkthrough?",
3267-
"description": "Use the ``Welcome: Open Walkthrough`` command to revisit any walkthrough!",
3268-
"media": {
3269-
"image": "icon.png",
3270-
"altText": "rust-analyzer logo"
3271-
}
3272-
}
3273-
]
3274-
},
3275-
{
3276-
"id": "faq",
3277-
"title": "FAQ",
3278-
"description": "Here are some frequently asked questions about rust-analyzer.",
3279-
"steps": [
3280-
{
3281-
"id": "faq1",
3282-
"title": "What is rust-analyzer?",
3283-
"description": "rust-analyzer is a language server for Rust. It provides features like code completion, find references, and more.",
3284-
"media": {
3285-
"image": "icon.png",
3286-
"altText": "rust-analyzer logo"
3287-
}
3288-
},
3289-
{
3290-
"id": "faq2",
3291-
"title": "Why are all of these type hints showing up in my code?",
3292-
"description": "By default, rust-analyzer displays __inlay hints__ to help you understand your code better. You can disable them in your settings.json file with ``\"editor.inlayHints.enabled\": \"off\"``",
3293-
"media": {
3294-
"image": "icon.png",
3295-
"altText": "rust-analyzer logo"
3296-
}
3297-
},
3298-
{
3299-
"id": "faq3",
3300-
"title": "Where can I find more information about rust-analyzer?",
3301-
"description": "You can find more information about rust-analyzer in the [User Manual](https://rust-analyzer.github.io/manual.html).",
3302-
"media": {
3303-
"image": "icon.png",
3304-
"altText": "rust-analyzer logo"
3305-
},
3306-
"completionEvents": [
3307-
"onLink:https://rust-analyzer.github.io/manual.html"
3308-
]
33093270
}
33103271
]
33113272
}

0 commit comments

Comments
 (0)