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

Add docs #13

Closed
wants to merge 32 commits into from
Closed

Add docs #13

wants to merge 32 commits into from

Conversation

thir820
Copy link
Collaborator

@thir820 thir820 commented Oct 21, 2024

Changes

  • Prepare mdbook to document the tools.

Dependencies:

none

Tests results

n/a

Developer Checklist:

  • n/a Test: Changes are tested
  • Doc: Documentation has been updated
  • Git: Informative git commit message(s)
  • n/a Issue: If a related GitHub issue exists, linking is done

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

@thir820 thir820 closed this Oct 21, 2024
@thir820 thir820 deleted the add_docs branch October 21, 2024 08:11
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