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

made error documentation headings more standard #367

Merged
merged 2 commits into from
Sep 27, 2023

Conversation

nh916
Copy link
Contributor

@nh916 nh916 commented Sep 22, 2023

Description

made error documentation headings more standard. How To Fix is a good heading, but less common and could be written better

Changes

  • Changed How To Fix with Troubleshooting which is very standard within technical documentations and and well worded

Screenshots

Before

documentation headings before change

image

After

documentation headings after change

image

Known Issues

Notes

Checklist

  • My name is on the list of contributors (CONTRIBUTORS.md) in the pull request source branch.
  • I have updated the documentation to reflect my changes.

* `How To Fix` is a good heading, but less common and could be written better
* Changed `How To Fix` with `Troubleshooting` which is very standard and well worded
@trunk-io
Copy link

trunk-io bot commented Sep 22, 2023

Merging to develop in this repository is managed by Trunk.

  • To merge this pull request, check the box to the left or comment /trunk merge below.

@nh916 nh916 requested a review from InnocentBug September 22, 2023 22:51
@nh916 nh916 merged commit 55988bc into develop Sep 27, 2023
12 checks passed
@nh916 nh916 deleted the upgrade-documentation-exceptions-heading-wording branch September 27, 2023 21:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants