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

DOC: Re-organizing documentation #219

Merged
merged 7 commits into from
May 23, 2024
Merged

DOC: Re-organizing documentation #219

merged 7 commits into from
May 23, 2024

Conversation

rlundeen2
Copy link
Contributor

@rlundeen2 rlundeen2 commented May 22, 2024 •
edited
Loading

Description

  • Added pre-commit hook to check for broken links
  • Created Contributing Section and broke up the contributor guide
  • Updated exception handling recommendations
  • Added testing documentation from our internal wiki
  • Added style documentation from our internal wiki

romanlutz
romanlutz approved these changes May 23, 2024
View reviewed changes
Copy link
Contributor

@romanlutz romanlutz left a comment

Choose a reason for hiding this comment

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

Woah that's a lot of content! Thanks for structuring it better!

doc/contributing/style_guide.md Outdated Show resolved Hide resolved
doc/contributing/installation.md Outdated Show resolved Hide resolved
doc/contributing/installation.md Show resolved Hide resolved
.github/check_links.py Outdated Show resolved Hide resolved
rlundeen2 and others added 3 commits May 22, 2024 18:03
@rlundeen2 @romanlutz
Update doc/contributing/style_guide.md
a4a795d 
Co-authored-by: Roman Lutz <romanlutz13@gmail.com>
@rlundeen2 @romanlutz
Update doc/contributing/installation.md
af22606 
Co-authored-by: Roman Lutz <romanlutz13@gmail.com>
@rlundeen2
pr feedback
3b3977e
@rlundeen2 rlundeen2 merged commit e43ee67 into Azure:main May 23, 2024
3 of 5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@romanlutz romanlutz romanlutz approved these changes

@rdheekonda rdheekonda rdheekonda 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.

None yet
3 participants
@rlundeen2 @romanlutz @rdheekonda