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 user guide #179

Merged
merged 8 commits into from
Sep 12, 2024
Merged

Add user guide #179

merged 8 commits into from
Sep 12, 2024

Conversation

davorrunje
Copy link
Contributor

Description

Please include a summary of the change and specify which issue is being addressed. Additionally, provide relevant motivation and context.

Fixes # (issue number)

Type of change

Please delete options that are not relevant.

  • Documentation (typos, code examples, or any documentation updates)
  • Bug fix (a non-breaking change that resolves an issue)
  • New feature (a non-breaking change that adds functionality)
  • Breaking change (a fix or feature that would disrupt existing functionality)
  • This change requires a documentation update

Checklist

  • My code adheres to the style guidelines of this project (scripts/lint.sh shows no errors)
  • I have conducted a self-review of my own code
  • I have made the necessary changes to the documentation
  • My changes do not generate any new warnings
  • I have added tests to validate the effectiveness of my fix or the functionality of my new feature
  • Both new and existing unit tests pass successfully on my local environment by running scripts/test-cov.sh
  • I have ensured that static analysis tests are passing by running scripts/static-anaylysis.sh
  • I have included code examples to illustrate the modifications

@davorrunje davorrunje marked this pull request as draft September 10, 2024 22:01
@davorrunje davorrunje changed the title Restured documentation Restuctured documentation Sep 10, 2024
@kumaranvpl kumaranvpl added this pull request to the merge queue Sep 12, 2024
Merged via the queue into main with commit db90194 Sep 12, 2024
20 of 21 checks passed
@kumaranvpl kumaranvpl deleted the refactor-docs branch September 12, 2024 18:52
@davorrunje davorrunje mentioned this pull request Sep 13, 2024
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.

3 participants