Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: restructure apidocs page tree #2530

Merged
merged 7 commits into from
Nov 12, 2023
Merged

docs: restructure apidocs page tree #2530

merged 7 commits into from
Nov 12, 2023

Conversation

LARVAIDE
Copy link
Contributor

@LARVAIDE LARVAIDE commented Nov 7, 2023 •
edited by ST-DDT
Loading

@LARVAIDE LARVAIDE requested a review from a team November 7, 2023 11:24
@LARVAIDE LARVAIDE requested a review from a team as a code owner November 7, 2023 11:24
@codecov Codecov
Copy link

codecov bot commented Nov 7, 2023 •
edited
Loading

Codecov Report

Merging #2530 (b1ae482) into next (f730125) will decrease coverage by 0.01%.
Report is 1 commits behind head on next.
The diff coverage is n/a.

Additional details and impacted files 
@@            Coverage Diff             @@
##             next    #2530      +/-   ##
==========================================
- Coverage   99.58%   99.57%   -0.01%     
==========================================
  Files        2794     2794              
  Lines      249473   249473              
  Branches     1086     1079       -7     
==========================================
- Hits       248429   248412      -17     
- Misses       1016     1033      +17     
  Partials       28       28

see 1 file with indirect coverage changes

@ST-DDT
Copy link
Member

ST-DDT commented Nov 7, 2023

Please use the new groupBy function instead of array.reduce:
https://github.com/faker-js/faker/blob/next/src/internal/group-by.ts

@ST-DDT ST-DDT added c: docs Improvements or additions to documentation needs rebase There is a merge conflict p: 1-normal Nothing urgent labels Nov 7, 2023
@ST-DDT ST-DDT added this to the vAnytime milestone Nov 7, 2023
@LARVAIDE LARVAIDE closed this Nov 8, 2023
@LARVAIDE LARVAIDE reopened this Nov 8, 2023
@LARVAIDE
Copy link
Contributor Author

LARVAIDE commented Nov 8, 2023

Replaced reduce

@ST-DDT ST-DDT removed the needs rebase There is a merge conflict label Nov 8, 2023
@ST-DDT ST-DDT mentioned this pull request Nov 8, 2023
Merged
@ST-DDT
Copy link
Member

ST-DDT commented Nov 8, 2023

It looks like there are some formatting errors.

@ST-DDT
Copy link
Member

ST-DDT commented Nov 8, 2023

I created PR #2532 to improve the groupBy function to allow removing the apiCategory from the final data.

ST-DDT
ST-DDT reviewed Nov 9, 2023
View reviewed changes
docs/.vitepress/api-pages.ts Outdated Show resolved Hide resolved
scripts/apidoc/utils.ts Outdated Show resolved Hide resolved
scripts/apidoc/writer.ts Outdated Show resolved Hide resolved
scripts/apidoc/writer.ts Outdated Show resolved Hide resolved
@matthewmayer
Copy link
Contributor

Sorry got a bit lost with how this actually looks, can you attach a screenshot of the resulting output for the sidebar?

ST-DDT
ST-DDT reviewed Nov 10, 2023
View reviewed changes
scripts/apidoc/writer.ts Outdated Show resolved Hide resolved
scripts/apidoc/writer.ts Outdated Show resolved Hide resolved
@LARVAIDE
Copy link
Contributor Author

@matthewmayer
image

@ST-DDT ST-DDT changed the title docs: Add API classification sorting rules docs: restructure apidocs page tree Nov 10, 2023
ST-DDT
ST-DDT approved these changes Nov 10, 2023
View reviewed changes
Copy link
Member

@ST-DDT ST-DDT left a comment

Choose a reason for hiding this comment

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

Looks good to me. Thanks for bringing this to our attention and providing a fix. ❤️

@ST-DDT ST-DDT requested review from a team November 10, 2023 16:57
@ST-DDT ST-DDT enabled auto-merge (squash) November 12, 2023 16:31
@ST-DDT ST-DDT merged commit 26f298c into faker-js:next Nov 12, 2023
18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ST-DDT ST-DDT ST-DDT approved these changes

@matthewmayer matthewmayer matthewmayer approved these changes

Assignees

@LARVAIDE LARVAIDE

Labels
c: docs Improvements or additions to documentation p: 1-normal Nothing urgent
Projects
None yet
Milestone
vAnytime
Development

Successfully merging this pull request may close these issues.

Why not sort the API queries in the document?
4 participants
@LARVAIDE @ST-DDT @matthewmayer @pengbo-airgram