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 initial usecases to homepage #1864

Merged
merged 3 commits into from
Jan 22, 2024
Merged

add initial usecases to homepage #1864

merged 3 commits into from
Jan 22, 2024

Conversation

RossKen
Copy link
Contributor

@RossKen RossKen commented Jan 19, 2024

Type of PR

  • BUG
  • FEAT
  • MAINT
  • DOC

Is your Pull Request linked to an existing Issue or Pull Request?

NA

Give a brief description for the solution you have provided

First draft of adding use cases to the docs. I think this will be helpful to keep a centralised list of use cases (or at least the ones we can provide a public link to). A couple of point I would appreciate some thoughts on:

  • Currently just on the docs homepage, not the gitbhub readme. Is this an issue? Should we have it in both places? The structure would have to change if we wanted consistency
  • Where should it live on the homepage? Is it visible enough where it is at the moment?
  • Are there any examples we are missing?

PR Checklist

  • Added documentation for changes
  • Added feature to example notebooks or tutorial (if appropriate)
  • Added tests (if appropriate)
  • Updated CHANGELOG.md (if appropriate)
  • Made changes based off the latest version of Splink
  • Run the linter

@RossKen RossKen requested a review from RobinL January 19, 2024 16:22
docs/index.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
RossKen and others added 2 commits January 22, 2024 11:04
Co-authored-by: Robin Linacre <robin.linacre@digital.justice.gov.uk>
Co-authored-by: Robin Linacre <robin.linacre@digital.justice.gov.uk>
@RossKen RossKen merged commit b6ce164 into master Jan 22, 2024
2 checks passed
@RossKen RossKen deleted the use_cases branch January 22, 2024 10:23
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.

None yet

2 participants