Skip to content

docs(website): restructure Guide into Getting Started, Configuration, and CLI Reference#548

Merged
fansenze merged 1 commit intomainfrom
docs/guide-restructure-20260319
Mar 19, 2026
Merged

docs(website): restructure Guide into Getting Started, Configuration, and CLI Reference#548
fansenze merged 1 commit intomainfrom
docs/guide-restructure-20260319

Conversation

@fansenze
Copy link
Copy Markdown
Contributor

@fansenze fansenze commented Mar 19, 2026 •
edited
Loading

Summary

  • Rewrite Getting Started with JS/TS flat config, rslint --init, VS Code extension setup, and PackageManagerTabs for installation
  • Rewrite Configuration page (standalone, kept in top nav) covering presets, all config options, config merging semantics, and deprecated JSON config note
  • Add CLI Reference page with all flags, output formats (default, jsonline, github), exit codes, CI integration (GitHub Actions example), and environment variables
  • Add Inline Directives page covering all ESLint-compatible disable/enable comment formats
  • Guide sidebar: Getting Started, CLI Reference, Inline Directives

Snapshot

image

Checklist

  • Tests updated (or not required).
  • Documentation updated (or not required).

@gemini-code-assist
Copy link
Copy Markdown

gemini-code-assist bot commented Mar 19, 2026

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly reorganizes the Rslint documentation website, transforming the monolithic 'Guide' into a more modular and user-friendly structure. By creating dedicated sections for 'Getting Started', 'Configuration', and 'CLI Reference', the changes aim to enhance content discoverability and provide clearer, more focused information for users at different stages of their Rslint journey. This update improves the overall user experience by making essential information more accessible and logically grouped.

Highlights

  • Documentation Restructuring: The 'Guide' section has been restructured into three distinct pages: 'Getting Started', 'Configuration', and 'CLI Reference' for improved organization and clarity.
  • Getting Started Guide Enhanced: The 'Getting Started' page was rewritten to include details on JS/TS flat config, rslint --init for configuration generation, and comprehensive VS Code extension setup instructions.
  • Dedicated Configuration Page: A new 'Configuration' page was added, detailing presets, all available configuration options (files, ignores, rules, plugins, languageOptions, settings), inline directives, config merging semantics, and a note on deprecated JSON configuration.
  • Comprehensive CLI Reference: A new 'CLI Reference' page was introduced, covering all command-line flags, output formats (default, jsonline, github), exit codes, CI integration examples (GitHub Actions), and environment variables.
  • Navigation Updates: The standalone '/config/' page was merged into the Guide sidebar, and the 'Configuration' link was removed from the top navigation bar to reflect the new structure.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

gemini-code-assist[bot]
gemini-code-assist bot reviewed Mar 19, 2026
View reviewed changes
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request refactors the documentation structure by moving the comprehensive 'Configuration' guide from a standalone section to a new page within the 'Guide' section. It also introduces a new 'CLI Reference' page, detailing command-line usage, options, output formats, and CI integration. The navigation and guide metadata files have been updated to reflect these changes, and the old configuration page now redirects to the new location. The updated configuration documentation emphasizes a new flat config format using JS/TS files, deprecating the previous JSON format.

@fansenze fansenze force-pushed the docs/guide-restructure-20260319 branch from 1e3bdd1 to 53446a9 Compare March 19, 2026 06:49
@cloudflare-workers-and-pages
Copy link
Copy Markdown

cloudflare-workers-and-pages bot commented Mar 19, 2026 •
edited
Loading

Deploying rslint with  Cloudflare Pages  Cloudflare Pages

Latest commit: 215439d
Status: ✅  Deploy successful!
Preview URL: https://ab8d3b72.rslint.pages.dev
Branch Preview URL: https://docs-guide-restructure-20260.rslint.pages.dev

View logs

@fansenze fansenze force-pushed the docs/guide-restructure-20260319 branch 5 times, most recently from e80fa53 to 215439d Compare March 19, 2026 07:03
@fansenze
docs(website): restructure Guide into Getting Started, Configuration,…
0658a43 
… and CLI Reference

- Rewrite Getting Started with JS/TS flat config, rslint --init, and
  VS Code extension setup
- Add Configuration page with presets, all config options, inline
  directives, config merging semantics, and deprecated JSON note
- Add CLI Reference page with all flags, output formats, exit codes,
  CI integration (GitHub Actions), and environment variables
- Merge standalone Config page into Guide (redirect to /guide/configuration)
- Remove Configuration from top nav bar (content now in Guide sidebar)
- Add sidebar with 3-page structure via _meta.json
@fansenze fansenze force-pushed the docs/guide-restructure-20260319 branch from 215439d to 0658a43 Compare March 19, 2026 07:10
@fansenze fansenze requested review from chenjiahan and hardfist March 19, 2026 07:17
@fansenze fansenze merged commit 914a7a7 into main Mar 19, 2026
16 of 17 checks passed
@fansenze fansenze deleted the docs/guide-restructure-20260319 branch March 19, 2026 11:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@chenjiahan chenjiahan chenjiahan approved these changes

@hardfist hardfist Awaiting requested review from hardfist

+1 more reviewer

@gemini-code-assist gemini-code-assist[bot] gemini-code-assist[bot] left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

release: document

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@fansenze @chenjiahan