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

Update documentation and add pre-commit tooling #77

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

Conversation

VeckoTheGecko
Copy link
Collaborator

@VeckoTheGecko VeckoTheGecko commented Nov 18, 2024

Changes:

  • Update README
  • Documentation
    • New homepage (with cards)
    • Roadmap page with embedded mindmap and link to discussion forum
    • New contributing guidelines (feedback welcome) with installation instructions
  • Pre-commit tooling
  • Removing requirements.txt
  • Delete duplicate notebooks

There is still some room for improvement in the docs/readme in terms of copy-editing (e.g., the purpose of the project, and the direction of the project). Items in the documentation that require deeper thought, or require development beyond just documentation changes have been noted with TODO blocks.

- Update homepage with buttons and icons
- Update installation details and add contributing guide
(until we remove notebook duplication, then we can run these hooks)
@VeckoTheGecko
Copy link
Collaborator Author

Re. the duplicate notebooks, I ran a diff on them. None of the duplicate notebooks in Diagnostics were different to the tutorial ones (except small formatting details). I've gone ahead and deleted the duplicates in Diagnostics.

Also, is docs/tutorials going to be the home for the notebooks? Should I move the remaining ones to that folder?

Diagnostics/hex_labelling_demo.ipynb
Diagnostics/2DHistogram_method01.ipynb
Diagnostics/flock_diagnostics.ipynb

@VeckoTheGecko
Copy link
Collaborator Author

@sruehs and @LauraGomezNavarro any thoughts on these changes?

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.

1 participant