Skip to content

Comments

[RF-DOCS] Update Rails Error Reporting Guide [ci skip]#1

Open
OughtPuts wants to merge 17 commits intomainfrom
harriet-guides-error-reporting
Open

[RF-DOCS] Update Rails Error Reporting Guide [ci skip]#1
OughtPuts wants to merge 17 commits intomainfrom
harriet-guides-error-reporting

Conversation

@OughtPuts
Copy link
Owner

@OughtPuts OughtPuts commented Sep 1, 2024

Motivation / Background

This PR updates the Rails Error Reporting guide.

Additional information

  • 'For Libraries' is made into a top section and renamed 'Error-reporting Libraries'
  • Various important paragraphs are reformatted into notes.
  • To aid understanding for beginners, links are added when various concepts are referenced e.g. 'railties', 'jobs' etc.
  • Sections are added on unexpected, unsubscribe and disable.
  • Various wording tweaks are made for improved readability and easier understanding.

Checklist

Before submitting the PR make sure the following are checked:

  • This Pull Request is related to one change. Unrelated changes should be opened in separate PRs.
  • Commit message has a detailed description of what changed and why. If this PR fixes a related issue include it in the commit message. Ex: [Fix #issue-number]

@OughtPuts OughtPuts marked this pull request as draft September 1, 2024 11:20
@OughtPuts OughtPuts changed the title Harriet guides error reporting [ci skip] Update Rails Error Reporting Guide [ci skip] Sep 1, 2024
@OughtPuts OughtPuts marked this pull request as ready for review September 1, 2024 11:30
@OughtPuts OughtPuts changed the title Update Rails Error Reporting Guide [ci skip] [RF-DOCS] Update Rails Error Reporting Guide [ci skip] Sep 1, 2024
@OughtPuts OughtPuts requested review from Ridhwana and p8 September 2, 2024 08:10
Copy link
Collaborator

@bhumi1102 bhumi1102 left a comment

Choose a reason for hiding this comment

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

Good work @OughtPuts on your first guide! I've left minor comments and some rewordings.

I'm half way done.

Copy link
Collaborator

@bhumi1102 bhumi1102 left a comment

Choose a reason for hiding this comment

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

Nice work @OughtPuts 🎉

All done with my review. Let me know if you have any questions on any of my comments.

@p8
Copy link
Collaborator

p8 commented Sep 3, 2024

Looks great!

@p8
Copy link
Collaborator

p8 commented Sep 3, 2024

Maybe it makes sense to bump the headers one level higher?
This could make the sidebar have more levels?
image
On the other hand, this is a short guide...

@OughtPuts
Copy link
Owner Author

Maybe it makes sense to bump the headers one level higher? This could make the sidebar have more levels? image On the other hand, this is a short guide...

hmmm yeah, I know what you mean, don't want the sidebar to be overkill? I've left it for now but I'm going to mull over that as I address other internal/community changes!

@OughtPuts OughtPuts force-pushed the harriet-guides-error-reporting branch from 177a9f8 to f3a7853 Compare September 11, 2024 16:44
@OughtPuts OughtPuts force-pushed the harriet-guides-error-reporting branch from 8040d06 to c3ea25b Compare October 2, 2024 17:27
@OughtPuts OughtPuts force-pushed the harriet-guides-error-reporting branch from c3ea25b to 6bb0265 Compare October 2, 2024 17:40
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.

4 participants