Skip to content

Conversation

@Josmithr
Copy link
Contributor

Part of an ongoing effort to collapse recommended into minimal-deprecated so we can remove the "minimal" config variant.

The description component of the API docs is the most important, and should always be present (for anything documented). This is what appears first in intellisense and what appears top-level views in our published API docs.

Also leverages Claude Code to fill in missing documentation per our docs guidelines. I audited these changes and reverted anything that seemed questionable. Feedback from area owners on how to fix / improve these docs is appreciated :)

Copilot AI review requested due to automatic review settings January 12, 2026 22:40
@Josmithr Josmithr requested review from a team as code owners January 12, 2026 22:40
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

@Josmithr Josmithr requested a review from a team January 12, 2026 23:32
@Josmithr Josmithr requested a review from a team as a code owner January 13, 2026 00:38
@github-actions
Copy link
Contributor

🔗 No broken links found! ✅

Your attention to detail is admirable.

linkcheck output


> [email protected] ci:check-links /home/runner/work/FluidFramework/FluidFramework/docs
> start-server-and-test "npm run serve -- --no-open" 3000 check-links

1: starting server using command "npm run serve -- --no-open"
and when url "[ 'http://127.0.0.1:3000' ]" is responding with HTTP status code 200
running tests using command "npm run check-links"


> [email protected] serve
> docusaurus serve --no-open

[SUCCESS] Serving "build" directory at: http://localhost:3000/

> [email protected] check-links
> linkcheck http://localhost:3000 --skip-file skipped-urls.txt

Crawling...

Stats:
  248787 links
    1796 destination URLs
    2036 URLs ignored
       0 warnings
       0 errors


Copy link
Member

@tylerbutler tylerbutler left a comment

Choose a reason for hiding this comment

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

One problem with this is that the server release group uses minimal. So if we make changes to that config, it implies server work that may not be accounted for. I recommend keeping minimal as it is and moving packages to recommended instead.

The other minor issue is that changes to the old configs will need to be manually moved into the new eslint9-native config that's in progress.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants