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

fix: removing toc to fix the docs html #341

Merged
merged 3 commits into from
Jan 30, 2022
Merged

fix: removing toc to fix the docs html #341

merged 3 commits into from
Jan 30, 2022

Conversation

JessicaSachs
Copy link
Contributor

@JessicaSachs JessicaSachs commented Jan 29, 2022 •
edited
Loading

This removes the TOC from the codegen. It's okay. We'll improve the Docs UX shortly.

Should solve #327

@JessicaSachs JessicaSachs requested a review from a team as a code owner January 29, 2022 04:04
@import-brain import-brain added the c: bug Something isn't working label Jan 29, 2022
ST-DDT
ST-DDT previously approved these changes Jan 29, 2022
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.

Strange cause, but works.

@ST-DDT ST-DDT requested a review from a team January 29, 2022 10:54
Shinigami92
Shinigami92 reviewed Jan 29, 2022
View reviewed changes
Copy link
Member

@Shinigami92 Shinigami92 left a comment

Choose a reason for hiding this comment

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

I'm okay for now with this change/removal of toc, because in the sidebar you can still the what functions are there.

cypress/e2e/smoke.cy.ts Show resolved Hide resolved
cypress/e2e/smoke.cy.ts Show resolved Hide resolved
@Shinigami92 Shinigami92 added c: docs Improvements or additions to documentation c: test labels Jan 29, 2022
@Shinigami92 Shinigami92 linked an issue Jan 29, 2022 that may be closed by this pull request
The last returns and example section on each api docs page vanishes after reload #327
Closed
@ST-DDT ST-DDT mentioned this pull request Jan 30, 2022
Closed
@ST-DDT ST-DDT merged commit c932942 into main Jan 30, 2022
@ST-DDT ST-DDT deleted the fix/remove-malformed-toc branch January 30, 2022 10:16
bmenant pushed a commit to bmenant/faker that referenced this pull request Mar 11, 2022
@JessicaSachs @Shinigami92 @bmenant
fix: removing toc to fix the docs html (faker-js#341)
1192d76 
Co-authored-by: Shinigami <[email protected]>
demipel8 pushed a commit to demipel8/faker that referenced this pull request Mar 11, 2022
@JessicaSachs @Shinigami92 @demipel8
fix: removing toc to fix the docs html (faker-js#341)
b99e99f 
Co-authored-by: Shinigami <[email protected]>
demipel8 pushed a commit to demipel8/faker that referenced this pull request Mar 11, 2022
@JessicaSachs @Shinigami92 @demipel8
fix: removing toc to fix the docs html (faker-js#341)
52668e4 
Co-authored-by: Shinigami <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pkuczynski pkuczynski pkuczynski left review comments

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

@Shinigami92 Shinigami92 Shinigami92 approved these changes

Assignees

@JessicaSachs JessicaSachs

Labels
c: bug Something isn't working c: docs Improvements or additions to documentation c: test
Projects
None yet
Milestone
v6.0 - Ensure Project Foundation
Development

Successfully merging this pull request may close these issues.

The last returns and example section on each api docs page vanishes after reload
5 participants
@JessicaSachs @pkuczynski @ST-DDT @Shinigami92 @import-brain