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: switch doc links to stable #2152

Merged
merged 5 commits into from
May 15, 2023
Merged

docs: switch doc links to stable #2152

merged 5 commits into from
May 15, 2023

Conversation

Shinigami92
Copy link
Member

references #2151

@Shinigami92 Shinigami92 added the c: docs Improvements or additions to documentation label May 12, 2023
@Shinigami92 Shinigami92 self-assigned this May 12, 2023
@Shinigami92 Shinigami92 requested a review from a team May 12, 2023 12:35
@Shinigami92 Shinigami92 requested a review from a team as a code owner May 12, 2023 12:35
@Shinigami92 Shinigami92 added the p: 2-high Fix main branch label May 12, 2023
@Shinigami92 Shinigami92 marked this pull request as draft May 12, 2023 12:37
@Shinigami92
Copy link
Member Author

Shinigami92 commented May 12, 2023 •
edited
Loading

somehow the links on docs already working 👀

@ST-DDT and @matthewmayer did black magic in the past, did they?

So do I even need to switch all the links?
I still assume yes, because they affect the JSDoc tooltips in VSCode as well 🤔

@Shinigami92 Shinigami92 marked this pull request as ready for review May 12, 2023 12:38
@codecov
Copy link

codecov bot commented May 12, 2023 •
edited
Loading

Codecov Report

Merging #2152 (7d16693) into next (e0e9ae8) will not change coverage.
The diff coverage is 100.00%.

Additional details and impacted files 
@@           Coverage Diff           @@
##             next    #2152   +/-   ##
=======================================
  Coverage   99.59%   99.59%           
=======================================
  Files        2607     2607           
  Lines      244977   244977           
  Branches     1148     1149    +1     
=======================================
  Hits       243993   243993           
  Misses        957      957           
  Partials       27       27
Impacted Files Coverage Δ
src/faker.ts 91.86% <100.00%> (ø)
src/locale-proxy.ts 100.00% <100.00%> (ø)
src/modules/airline/index.ts 100.00% <100.00%> (ø)
src/modules/animal/index.ts 100.00% <100.00%> (ø)
src/modules/color/index.ts 99.79% <100.00%> (ø)
src/modules/commerce/index.ts 100.00% <100.00%> (ø)
src/modules/company/index.ts 100.00% <100.00%> (ø)
src/modules/database/index.ts 100.00% <100.00%> (ø)
src/modules/datatype/index.ts 100.00% <100.00%> (ø)
src/modules/date/index.ts 100.00% <100.00%> (ø)
... and 14 more

... and 1 file with indirect coverage changes

@matthewmayer
Copy link
Contributor

In the HTML version they are converted to relative links automagically

@matthewmayer
Copy link
Contributor

Should this PR target v8 instead of next?

@ST-DDT
Copy link
Member

ST-DDT commented May 12, 2023 •
edited
Loading

Should this PR target v8 instead of next?

No, since the changes are now stable features, they should point to the stable docs.

@ST-DDT
Copy link
Member

ST-DDT commented May 12, 2023

So do I even need to switch all the links?

Yes

ST-DDT
ST-DDT previously requested changes May 12, 2023
View reviewed changes
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
src/modules/finance/index.ts Show resolved Hide resolved
@Shinigami92 Shinigami92 force-pushed the 2151-link-docs-to-stable branch from 26d81e7 to 6c2bc92 Compare May 12, 2023 14:00
@Shinigami92 Shinigami92 requested a review from ST-DDT May 12, 2023 14:01
@matthewmayer
Copy link
Contributor

theres a lint error now.

@Shinigami92
Copy link
Member Author

theres a lint error now.

@matthewmayer HA LOL ^^
the readme wanted a \ escape for the *
thx for the ping anyway 👌

@Shinigami92 Shinigami92 requested a review from matthewmayer May 12, 2023 18:13
@Shinigami92
Copy link
Member Author

This PR needs a review of a @faker-js/maintainers to get merged.
I would like to release v8.0.1 as a Docs update release tomorrow if nothing else needs to be part of that release.

@Shinigami92 Shinigami92 requested a review from a team May 14, 2023 16:59
@Shinigami92 Shinigami92 dismissed ST-DDT’s stale review May 15, 2023 06:20

requested changes were made already 3 days ago

@Shinigami92 Shinigami92 enabled auto-merge (squash) May 15, 2023 06:24
@Shinigami92 Shinigami92 merged commit 8f741bd into next May 15, 2023
@Shinigami92 Shinigami92 deleted the 2151-link-docs-to-stable branch May 15, 2023 15:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@xDivisionByZerox xDivisionByZerox xDivisionByZerox approved these changes

@import-brain import-brain import-brain approved these changes

@prisis prisis prisis approved these changes

@ST-DDT ST-DDT Awaiting requested review from ST-DDT

@matthewmayer matthewmayer Awaiting requested review from matthewmayer

Assignees

@Shinigami92 Shinigami92

Labels
c: docs Improvements or additions to documentation p: 2-high Fix main branch
Projects
No open projects
Faker Roadmap
Status: Done
Milestone
v8.0 - Module Re-Shuffling
Development

Successfully merging this pull request may close these issues.
6 participants
@Shinigami92 @matthewmayer @ST-DDT @prisis @import-brain @xDivisionByZerox