Skip to content

docs: update documentation to refer to new example datasets and minor changes to README#204

Merged
JemmaLDaniel merged 1 commit into
mainfrom
chore-update-docs
Apr 24, 2026
Merged

docs: update documentation to refer to new example datasets and minor changes to README#204
JemmaLDaniel merged 1 commit into
mainfrom
chore-update-docs

Conversation

@JemmaLDaniel

@JemmaLDaniel JemmaLDaniel commented Apr 24, 2026

Copy link
Copy Markdown
Collaborator

Description

Amends references to previous randomly-generated sample data and removes the redundant make command to regenerate this data. This PR also brings the README.md into sync with the rest of the project: updating the Python badge to the version reflected in the pyproject.toml; fixing two broken links to the CLI and configuration docs pages; updating the package layout description and CLI options; and correcting minor typos.

@JemmaLDaniel JemmaLDaniel requested a review from KevinEloff April 24, 2026 14:13
@JemmaLDaniel JemmaLDaniel self-assigned this Apr 24, 2026
@JemmaLDaniel JemmaLDaniel added the documentation Improvements or additions to documentation label Apr 24, 2026
@JemmaLDaniel JemmaLDaniel force-pushed the chore-update-docs branch 3 times, most recently from 838f796 to bacfcfa Compare April 24, 2026 15:11
… corrections to README

chore: fix spacing in html and move layout description to Contributing section

@KevinEloff KevinEloff left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Looks great, thanks

@JemmaLDaniel JemmaLDaniel merged commit abcd540 into main Apr 24, 2026
6 checks passed
@JemmaLDaniel JemmaLDaniel deleted the chore-update-docs branch April 24, 2026 15:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants