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.

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

docs: add overview guides to specific modules #1929

Merged
merged 40 commits into from Mar 29, 2023

Conversation

matthewmayer
Copy link
Contributor

@matthewmayer matthewmayer commented Mar 14, 2023

fix #1928

examples:
image

image

image

@codecov
Copy link

codecov bot commented Mar 14, 2023

Codecov Report

Merging #1929 (6777928) into next (88e561a) will increase coverage by 0.01%.
The diff coverage is 100.00%.

❗ Current head 6777928 differs from pull request most recent head 9d902b6. Consider uploading reports for the commit 9d902b6 to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@
##             next    #1929      +/-   ##
==========================================
+ Coverage   99.61%   99.63%   +0.01%     
==========================================
  Files        2460     2450      -10     
  Lines      239942   239952      +10     
  Branches     1274     1276       +2     
==========================================
+ Hits       239024   239068      +44     
+ Misses        895      862      -33     
+ Partials       23       22       -1     
Impacted Files Coverage Δ
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%> (+<0.01%) ⬆️
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%> (ø)
src/modules/finance/index.ts 100.00% <100.00%> (ø)
src/modules/git/index.ts 100.00% <100.00%> (ø)
... and 14 more

... and 106 files with indirect coverage changes

@matthewmayer matthewmayer self-assigned this Mar 17, 2023
@matthewmayer matthewmayer marked this pull request as ready for review March 17, 2023 06:49
@matthewmayer matthewmayer requested a review from a team as a code owner March 17, 2023 06:49
@ST-DDT
Copy link
Member

ST-DDT commented Mar 17, 2023

I think the links wont work locally in our IDEs.
Should we use fully qualified links instead (and convert them to absolute links in the docs build)?

@ST-DDT ST-DDT added c: docs Improvements or additions to documentation p: 1-normal Nothing urgent labels Mar 17, 2023
src/modules/animal/index.ts Outdated Show resolved Hide resolved
src/modules/date/index.ts Outdated Show resolved Hide resolved
src/modules/person/index.ts Show resolved Hide resolved
src/modules/person/index.ts Show resolved Hide resolved
@matthewmayer
Copy link
Contributor Author

I think the links wont work locally in our IDEs.

Should we use fully qualified links instead (and convert them to absolute links in the docs build)?

What would a fully qualified link look like in markdown?

@ST-DDT
Copy link
Member

ST-DDT commented Mar 19, 2023

What would a fully qualified link look like in markdown?

It starts with https. Sorry if I messed up the terms.

@matthewmayer
Copy link
Contributor Author

Which hostname though?

@ST-DDT
Copy link
Member

ST-DDT commented Mar 19, 2023

I thought about using next until we release v8 and adjust the main docs version. In the docs build we should adjust it to absolute links (without hostname) though.
But I'm open to suggestions.

@matthewmayer matthewmayer requested a review from a team March 21, 2023 08:44
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.

Please also add a test to our signature tests

scripts/apidoc/signature.ts Outdated Show resolved Hide resolved
@matthewmayer
Copy link
Contributor Author

Please also add a test to our signature tests

the existing signature snapshot tests only seem to be for method signatures, not sure how to add for module comments?

ST-DDT
ST-DDT previously approved these changes Mar 24, 2023
@ST-DDT ST-DDT requested a review from a team March 24, 2023 16:08
src/modules/airline/index.ts Outdated Show resolved Hide resolved
src/modules/airline/index.ts Outdated Show resolved Hide resolved
src/modules/animal/index.ts Outdated Show resolved Hide resolved
src/modules/color/index.ts Outdated Show resolved Hide resolved
src/modules/commerce/index.ts Outdated Show resolved Hide resolved
src/modules/person/index.ts Outdated Show resolved Hide resolved
src/modules/person/index.ts Outdated Show resolved Hide resolved
src/modules/person/index.ts Outdated Show resolved Hide resolved
src/modules/person/index.ts Outdated Show resolved Hide resolved
src/modules/person/index.ts Outdated Show resolved Hide resolved
Co-authored-by: Eric Cheng <ericcheng9316@gmail.com>
@ST-DDT ST-DDT requested review from import-brain and a team March 26, 2023 09:57
src/modules/image/index.ts Show resolved Hide resolved
src/modules/date/index.ts Outdated Show resolved Hide resolved
src/modules/date/index.ts Outdated Show resolved Hide resolved
src/modules/helpers/index.ts Outdated Show resolved Hide resolved
matthewmayer and others added 2 commits March 29, 2023 10:57
Co-authored-by: ST-DDT <ST-DDT@gmx.de>
@ST-DDT ST-DDT requested review from xDivisionByZerox and a team March 29, 2023 06:49
@ST-DDT ST-DDT changed the title docs: Add overview guides to specific modules docs: add overview guides to specific modules Mar 29, 2023
@ST-DDT ST-DDT enabled auto-merge (squash) March 29, 2023 13:32
@ST-DDT ST-DDT merged commit 3562e87 into faker-js:next Mar 29, 2023
16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c: docs Improvements or additions to documentation p: 1-normal Nothing urgent s: accepted Accepted feature / Confirmed bug
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Add overview guides to specific modules
5 participants