Skip to content

docs: avoid code in heading #5297

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
Merged
merged 12 commits into from
Aug 25, 2021
Merged

docs: avoid code in heading #5297

merged 12 commits into from
Aug 25, 2021

Conversation

snitin315
Copy link
Member

Avoid code(``) in heading as it has different font family and also for consistency throughout the docs

@vercel
Copy link

vercel bot commented Aug 14, 2021 •
edited
Loading

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/webpack-docs/webpack-js-org/AmCv2YLQNRZDYXLsxmZ1P6dsHjVA
✅ Preview: https://webpack-js-org-git-fix-resolve-headings-webpack-docs.vercel.app

@chenxsan
Copy link
Member

There're many others, can you replace them all in this pull request? It won't be a problem to downstream repositories as far as I can see.

@snitin315 snitin315 changed the title docs(configuration): avoid code in heading docs: avoid code in heading Aug 15, 2021
@snitin315
Copy link
Member Author

I left performance.mdx as it will be updated in #5295

@snitin315 snitin315 force-pushed the fix-resolve-headings branch from 84e9fd0 to 4239345 Compare August 15, 2021 03:42
@snitin315
Copy link
Member Author

I don't know why CI is failing 😞

@chenxsan
Copy link
Member

The error isn't helpful. Maybe you can push just one commit every time to isolate the change causing the problem.

@snitin315
Copy link
Member Author

looking into it 👍🏻

@snitin315 snitin315 mentioned this pull request Aug 24, 2021
Closed
@snitin315
Copy link
Member Author

Ok, I think it's somehow related to mdx, without code, in test.{option} {option} is being considered as a variable I guess. I will revert such headings for now.

@snitin315 snitin315 force-pushed the fix-resolve-headings branch from 4239345 to c0dd299 Compare August 24, 2021 13:01
@snitin315 snitin315 force-pushed the fix-resolve-headings branch from 0cff217 to c0b399c Compare August 24, 2021 13:36
@snitin315
Copy link
Member Author

Now something is wrong with the last commit ffb32e9, the error isn't helpful as well.

chenxsan
chenxsan reviewed Aug 25, 2021
View reviewed changes
snitin315
snitin315 commented Aug 25, 2021
View reviewed changes
@snitin315 @chenxsan
Apply suggestions from code review
d23b204 
Co-authored-by: Sam Chen <chenxsan@gmail.com>
@snitin315 snitin315 requested a review from chenxsan August 25, 2021 11:16
chenxsan
chenxsan approved these changes Aug 25, 2021
View reviewed changes
Copy link
Member

@chenxsan chenxsan 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. Thanks for the hard work!

@chenxsan chenxsan merged commit bf85ef6 into master Aug 25, 2021
@chenxsan chenxsan deleted the fix-resolve-headings branch August 25, 2021 11:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@chenxsan chenxsan chenxsan approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@snitin315 @chenxsan