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

Minor documentation formatting and restructuring #9

Merged
merged 7 commits into from
Mar 18, 2024

Conversation

mherwig
Copy link
Collaborator

@mherwig mherwig commented Mar 15, 2024

I updated the README.md so that it "looks and feels" like the READMEs of all other components (only minor changes).

@mherwig mherwig requested a review from a team as a code owner March 15, 2024 14:50
@mherwig mherwig requested review from chrisingenhaag and julian-spierefka and removed request for a team March 15, 2024 14:50
Copy link
Member

@Th3Shadowbroker Th3Shadowbroker left a comment

Choose a reason for hiding this comment

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

Please check my suggestions.
I'd appreciate it if you could have a look as well @ledex 🙂

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@Th3Shadowbroker Th3Shadowbroker requested review from ledex and removed request for chrisingenhaag and julian-spierefka March 15, 2024 15:45
@Th3Shadowbroker
Copy link
Member

As this PR only updates one file, I'd suggested that the PR is squashed on merge.

@Th3Shadowbroker Th3Shadowbroker changed the title docs: minor documentation formatting and restructuring Minor documentation formatting and restructuring Mar 15, 2024
@Th3Shadowbroker Th3Shadowbroker added the documentation Improvements or additions to documentation label Mar 15, 2024
Copy link

@ledex ledex left a comment

Choose a reason for hiding this comment

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

Appart from @Th3Shadowbroker's suggestions it looks good to me.

mherwig and others added 5 commits March 18, 2024 10:34
Co-authored-by: Jens Fischer <[email protected]>
Co-authored-by: Jens Fischer <[email protected]>
Co-authored-by: Jens Fischer <[email protected]>
Co-authored-by: Jens Fischer <[email protected]>
Co-authored-by: Jens Fischer <[email protected]>
Copy link
Collaborator Author

@mherwig mherwig left a comment

Choose a reason for hiding this comment

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

should be resolved now. Thanks

@chrisingenhaag chrisingenhaag dismissed Th3Shadowbroker’s stale review March 18, 2024 09:56

All suggestions are resolved as far as I see

@chrisingenhaag chrisingenhaag self-requested a review March 18, 2024 09:57
@Th3Shadowbroker Th3Shadowbroker self-requested a review March 18, 2024 10:07
@Th3Shadowbroker Th3Shadowbroker merged commit 7167b76 into main Mar 18, 2024
6 checks passed
@Th3Shadowbroker Th3Shadowbroker deleted the docs/minor-doc-changes branch March 18, 2024 10:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants