feat: assist documentation #1387
Draft
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
❌ Deploy Preview for biomejs failed. Why did it fail? →
|
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.
Summary
Documentation for the Biome Assist.
Lint doc codegen
I refactored the
lintdoc.rsto take the actions into account, too. Now we useRuleCategoryacross all functions to change the generation fo the code.Since assist actions don't emit a diagnostic, I decided to create an ad-hoc diagnostic for the sole purpose of generating a nice diff for the website, emitted using HTML
For the time being, assist actions don't generate a "actions sources" page.
Navigation and sidebar
I refactored the navigation bar. I removed the top level "Tools" and moved the "Linter" under the "Analyzer".
The Assist main page is under
/assist; the "rules" are called actions ->/assist/actions/use-sorted-keys.Important
I am still writing some docs for the
/assistpage