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 some developer documentation #77

Merged
merged 2 commits into from
Nov 1, 2024
Merged

Add some developer documentation #77

merged 2 commits into from
Nov 1, 2024

Conversation

AdrianDAlessandro
Copy link
Collaborator

@AdrianDAlessandro AdrianDAlessandro commented Nov 1, 2024

Description

This PR slightly rearranges the README so that there is a separation between the standard installation and usage instructions and the developer documentation. It also tidies up the existing markdown files to pass almost all of the markdownlint rules that were previously ignored

Fixes #62

Type of change

  • Documentation (non-breaking change that adds or improves the documentation)
  • New feature (non-breaking change which adds functionality)
  • Optimization (non-breaking, back-end change that speeds up the code)
  • Bug fix (non-breaking change which fixes an issue)
  • Breaking change (whatever its nature)

Key checklist

  • All tests pass (eg. pytest)
  • The documentation builds and looks OK (eg. mkdocs)
  • Pre-commit hooks run successfully (eg. pre-commit run --all-files)

Further checks

  • Code is commented, particularly in hard-to-understand areas
  • Tests added or an issue has been opened to tackle that in the future. (Indicate issue here: # (issue))

Copy link
Collaborator

@Thomas-Rowlands Thomas-Rowlands left a comment

Choose a reason for hiding this comment

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

Looks good thanks

@Thomas-Rowlands Thomas-Rowlands merged commit 0ba1bbd into main Nov 1, 2024
8 checks passed
@AdrianDAlessandro AdrianDAlessandro deleted the dev-docs branch November 1, 2024 14:08
@alexdewar
Copy link
Collaborator

Good cleanup 👍

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.

Create developer documentation
3 participants