docs(website): restructure documentation and add preset indicators#612
Merged
docs(website): restructure documentation and add preset indicators#612
Conversation
Contributor
There was a problem hiding this comment.
Code Review
This pull request significantly restructures the documentation by splitting the configuration and guide sections into multiple dedicated pages, such as 'Ignoring Files', 'Rules & Presets', 'CI Integration', and 'VSCode Extension'. It also enhances the rule manifest generation script to include preset information and updates the documentation theme to display these presets and support URL-based filtering for the rule implementation status. Feedback was provided regarding a missing error check during a file write operation and a redundant optional chaining check where the property is already guaranteed by the type definition.
Deploying rslint with
|
| Latest commit: |
f5fb7fb
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://b5bd32ae.rslint.pages.dev |
| Branch Preview URL: | https://docs-website-restructure-202.rslint.pages.dev |
cc99585 to
04ca6c9
Compare
- Split Guide section: extract VSCode Extension, CI Integration, Output Formats, Environment Variables into separate pages - Split Configuration section: extract Rules & Presets and Ignoring Files into dedicated pages - Reorder Guide sidebar: Getting Started → VSCode Extension → Features → CLI Reference sections - Add preset indicators to rule manifest via @rslint/core import - Add preset filter with URL sync to Rules overview table - Add preset table with configured values to individual rule detail pages - Add cross-reference links between CLI options and their detail pages - Add "View rules →" links from preset table to filtered Rules overview
04ca6c9 to
f5fb7fb
Compare
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
@rslint/coreconfigs directly. Rules overview table now has a Preset column with filter support. Individual rule detail pages show a preset table with the configured value (e.g.ts.configs.recommended→"error").--format,--no-color,--force-colorto their respective detail pages.Related Links
N/A
Checklist