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

Hypervisor doc #56

Open
wants to merge 17 commits into
base: main
Choose a base branch
from
Open

Hypervisor doc #56

wants to merge 17 commits into from

Conversation

MofX
Copy link
Collaborator

@MofX MofX commented Feb 14, 2025

Developer Checklist:

Checklists for documentation

  • Grammar: the content is grammatically correct
    (spelling, grammar, formatting, US English is used)
  • Comprehensibility/Unambiguousness: the content is easy readable, clear to understand
  • Correctness and consistency: the content is technically correct and consistent,
    no contradictions, no double descriptions
  • Terminology: technical terms are clear and they are used correctly and documented in the glossary
  • Level of detail: the content matches the detail level necessary for the reviewed object

Reviewer checklist:

  • Review: Changes are reviewed
  • Review: Tested by the reviewer

Checklists for documentation

  • Grammar: the content is grammatically correct
    (spelling, grammar, formatting, US English is used)
  • Comprehensibility/Unambiguousness: the content is easy readable, clear to understand
  • Correctness and consistency: the content is technically correct and consistent,
    no contradictions, no double descriptions
  • Terminology: technical terms are clear and they are used correctly and documented in the glossary
  • Level of detail: the content matches the detail level necessary for the reviewed object

@MofX MofX marked this pull request as ready for review February 19, 2025 06:58
Copy link
Collaborator

@matthiasb85 matthiasb85 left a comment

Choose a reason for hiding this comment

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

Some findings, primarily about language. I would recommend to use one line per sentence if possible.

MofX and others added 15 commits February 19, 2025 12:59
Co-authored-by: Matthias Beckert <matthias.beckert@elektrobit.com>
Co-authored-by: Matthias Beckert <matthias.beckert@elektrobit.com>
Co-authored-by: Matthias Beckert <matthias.beckert@elektrobit.com>
Co-authored-by: Matthias Beckert <matthias.beckert@elektrobit.com>
Co-authored-by: Matthias Beckert <matthias.beckert@elektrobit.com>
Co-authored-by: Matthias Beckert <matthias.beckert@elektrobit.com>
Co-authored-by: Matthias Beckert <matthias.beckert@elektrobit.com>
Co-authored-by: Matthias Beckert <matthias.beckert@elektrobit.com>
Co-authored-by: Matthias Beckert <matthias.beckert@elektrobit.com>
Co-authored-by: Matthias Beckert <matthias.beckert@elektrobit.com>
Co-authored-by: Matthias Beckert <matthias.beckert@elektrobit.com>
Co-authored-by: Matthias Beckert <matthias.beckert@elektrobit.com>
Co-authored-by: Matthias Beckert <matthias.beckert@elektrobit.com>
Co-authored-by: Matthias Beckert <matthias.beckert@elektrobit.com>
Co-authored-by: Matthias Beckert <matthias.beckert@elektrobit.com>
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