Rework website to be easier to navigate #188
Merged
+174
−164
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
DavisVaughan
force-pushed
the
feature/docs-update
branch
from
904cb6b to
f4ba2c1
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Also gives it a general refresh with respect to the fact that we are nearly ready with the extension. Also updates the README. I didn't really remove or add that much new stuff though, so review should mostly be about the overall structure.
The website nav now looks like
I'm imagining that each specific editor page (and the
Command linepage) should have 3 level 1 headers:Right now we just have Installation and Features for both VS Code/Positron and RStudio. And just Installation for the CLI. We can fill out more as we have time.
The overarching goal is to keep you from having to bounce around much. Most of the information you care about for, say, Positron, should be contained on 1 page (with the
air.tomlconfiguration guide being an exception, since that is generic across any IDE). This form also makes it easier to add more IDE setup pages, like Zed or Helix.